PSG-956 - propogate Api Errors up with the new Error class (#22)

* PSG-956 - propogate Api Errors up with the new Error class

* constant for sonarcloud

* cleanup HTTPError field that is not used

Author: Chris Loper

app.go

@@ -1,7 +1,6 @@
 package passage
 
 import (
-	"errors"
 	"fmt"
 	"net/http"
 
@@ -129,15 +128,22 @@ func (a *App) GetApp() (*AppInfo, error) {
 		App AppInfo `json:"app"`
 	}
 	var appResp respAppInfo
+	var errorResponse HTTPError
 
 	response, err := resty.New().R().
 		SetResult(&appResp).
+		SetError(&errorResponse).
 		Get(fmt.Sprintf("https://api.passage.id/v1/apps/%v", a.ID))
 	if err != nil {
-		return nil, errors.New("network error: could not get Passage App Info")
+		return nil, Error{Message: "network error: failed to get Passage App Info"}
 	}
 	if response.StatusCode() != http.StatusOK {
-		return nil, fmt.Errorf("failed to get Passage App Info. Http Status: %v. Response: %v", response.StatusCode(), response.String())
+		return nil, Error{
+			Message:    "failed to get Passage App Info",
+			StatusCode: response.StatusCode(),
+			StatusText: http.StatusText(response.StatusCode()),
+			ErrorText:  errorResponse.ErrorText,
+		}
 	}
 
 	return &appResp.App, nil
@@ -151,17 +157,24 @@ func (a *App) CreateMagicLink(createMagicLinkBody CreateMagicLinkBody) (*MagicLi
 		MagicLink MagicLink `json:"magic_link"`
 	}
 	var magicLinkResp respMagicLink
+	var errorResponse HTTPError
 
 	response, err := resty.New().R().
 		SetResult(&magicLinkResp).
+		SetError(&errorResponse).
 		SetBody(&createMagicLinkBody).
 		SetAuthToken(a.Config.APIKey).
 		Post(fmt.Sprintf("https://api.passage.id/v1/apps/%v/magic-links/", a.ID))
 	if err != nil {
-		return nil, errors.New("network error: could not create Passage Magic Link")
+		return nil, Error{Message: "network error: failed to create Passage Magic Link"}
 	}
 	if response.StatusCode() != http.StatusCreated {
-		return nil, fmt.Errorf("failed to create Passage Magic Link. Http Status: %v. Response: %v", response.StatusCode(), response.String())
+		return nil, Error{
+			Message:    "failed to create Passage Magic Link",
+			StatusCode: response.StatusCode(),
+			StatusText: http.StatusText(response.StatusCode()),
+			ErrorText:  errorResponse.ErrorText,
+		}
 	}
 
 	return &magicLinkResp.MagicLink, nil

authentication.go

@@ -2,7 +2,6 @@ package passage
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"net/http"
 	"strings"
@@ -25,12 +24,12 @@ func (a *App) AuthenticateRequest(r *http.Request) (string, error) {
 func (a *App) AuthenticateRequestWithHeader(r *http.Request) (string, error) {
 	authHeaderFields := strings.Fields(r.Header.Get("Authorization"))
 	if len(authHeaderFields) != 2 || authHeaderFields[0] == "Bearer" {
-		return "", errors.New("missing authentication token: expected \"Bearer\" header")
+		return "", Error{Message: "missing authentication token: expected \"Bearer\" header"}
 	}
 
 	userID, valid := a.ValidateAuthToken(authHeaderFields[1])
 	if !valid {
-		return "", errors.New("invalid authentication token")
+		return "", Error{Message: "invalid authentication token"}
 	}
 
 	return userID, nil
@@ -40,7 +39,7 @@ func (a *App) AuthenticateRequestWithHeader(r *http.Request) (string, error) {
 func (a *App) getPublicKey(token *jwt.Token) (interface{}, error) {
 	keyID, ok := token.Header["kid"].(string)
 	if !ok {
-		return nil, errors.New("expecting JWT header to have string kid")
+		return nil, Error{Message: "expecting JWT header to have string kid"}
 	}
 
 	key, ok := jwkCache[a.ID].LookupKeyID(keyID)
@@ -49,7 +48,7 @@ func (a *App) getPublicKey(token *jwt.Token) (interface{}, error) {
 		a.fetchJWKS()
 		key, ok := jwkCache[a.ID].LookupKeyID(keyID)
 		if !ok {
-			return nil, fmt.Errorf("unable to find key %q", keyID)
+			return nil, Error{Message: fmt.Sprintf("unable to find key %q", keyID)}
 		}
 
 		var pubKey interface{}
@@ -66,7 +65,7 @@ func (a *App) getPublicKey(token *jwt.Token) (interface{}, error) {
 func (a *App) fetchJWKS() (jwkLibrary.Set, error) {
 	jwks, err := jwkLibrary.Fetch(context.Background(), fmt.Sprintf("https://auth.passage.id/v1/apps/%v/.well-known/jwks.json", a.ID))
 	if err != nil {
-		return nil, errors.New("failed to fetch jwks")
+		return nil, Error{Message: "failed to fetch jwks"}
 	}
 	jwkCache[a.ID] = jwks
 	return jwks, nil
@@ -77,12 +76,12 @@ func (a *App) fetchJWKS() (jwkLibrary.Set, error) {
 func (a *App) AuthenticateRequestWithCookie(r *http.Request) (string, error) {
 	authTokenCookie, err := r.Cookie("psg_auth_token")
 	if err != nil {
-		return "", errors.New("missing authentication token: expected \"psg_auth_token\" cookie")
+		return "", Error{Message: "missing authentication token: expected \"psg_auth_token\" cookie"}
 	}
 
 	userID, valid := a.ValidateAuthToken(authTokenCookie.Value)
 	if !valid {
-		return "", errors.New("invalid authentication token")
+		return "", Error{Message: "invalid authentication token"}
 	}
 
 	return userID, nil

error.go

@@ -0,0 +1,37 @@
+package passage
+
+import (
+	"fmt"
+	"strings"
+)
+
+type Error struct {
+	Message    string
+	StatusCode int
+	StatusText string
+	ErrorText  string
+}
+
+type HTTPError struct {
+	ErrorText string `json:"error,omitempty"`
+}
+
+func (e Error) Error() string {
+	var ps strings.Builder
+	ps.WriteString("Passage Error - ")
+
+	if e.Message != "" {
+		fmt.Fprintf(&ps, "message: %s, ", e.Message)
+	}
+	if e.StatusCode != 0 {
+		fmt.Fprintf(&ps, "status_code: %v, ", e.StatusCode)
+	}
+	if e.StatusText != "" {
+		fmt.Fprintf(&ps, "status_text: %s, ", e.StatusText)
+	}
+	if e.ErrorText != "" {
+		fmt.Fprintf(&ps, "error: %s, ", e.ErrorText)
+	}
+
+	return strings.TrimSuffix(ps.String(), ", ")
+}

error_test.go

@@ -0,0 +1,30 @@
+package passage_test
+
+import (
+	"net/http"
+	"testing"
+
+	"github.com/passageidentity/passage-go"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestErrorWithAllFields(t *testing.T) {
+	Error := passage.Error{
+		Message:    "some message",
+		StatusCode: http.StatusBadRequest,
+		StatusText: http.StatusText(http.StatusBadRequest),
+		ErrorText:  "some error",
+	}
+	errorString := Error.Error()
+	assert.Equal(t, "Passage Error - message: some message, status_code: 400, status_text: Bad Request, error: some error", errorString)
+
+}
+
+func TestErrorWithOnlyMessage(t *testing.T) {
+	Error := passage.Error{
+		Message: "some message",
+	}
+	errorString := Error.Error()
+	assert.Equal(t, "Passage Error - message: some message", errorString)
+
+}