feat(pkg): standardize errors on internal http client

Author: henrybarreto

pkg/api/internalclient/billing.go

@@ -2,7 +2,7 @@ package internalclient
 
 import (
 	"context"
-	"net/http"
+	"errors"
 
 	"github.com/shellhub-io/shellhub/pkg/models"
 )
@@ -18,6 +18,8 @@ type billingAPI interface {
 	BillingEvaluate(ctx context.Context, tenantID string) (*models.BillingEvaluation, int, error)
 }
 
+var ErrBillingRequestFailed = errors.New("billing request failed")
+
 func (c *client) BillingReport(ctx context.Context, tenant string, action string) (int, error) {
 	res, err := c.http.
 		R().
@@ -26,7 +28,8 @@ func (c *client) BillingReport(ctx context.Context, tenant string, action string
 		SetQueryParam("action", action).
 		Post(c.Config.EnterpriseBaseURL + "/internal/billing/report")
 	if err != nil {
-		return http.StatusInternalServerError, err
+		// TODO: It shouldn't return the status code.
+		return res.StatusCode(), errors.Join(ErrBillingRequestFailed, err)
 	}
 
 	return res.StatusCode(), nil
@@ -42,7 +45,7 @@ func (c *client) BillingEvaluate(ctx context.Context, tenantID string) (*models.
 		SetResult(&eval).
 		Post(c.Config.EnterpriseBaseURL + "/internal/billing/evaluate")
 	if err != nil {
-		return eval, resp.StatusCode(), err
+		return nil, resp.StatusCode(), errors.Join(ErrBillingRequestFailed, err)
 	}
 
 	return eval, resp.StatusCode(), nil

pkg/api/internalclient/device.go

@@ -24,7 +24,7 @@ type deviceAPI interface {
 	DevicesHeartbeat(ctx context.Context, uid string) error
 
 	// Lookup performs a lookup operation based on the provided parameters.
-	Lookup(ctx context.Context, lookup map[string]string) (string, []error)
+	Lookup(ctx context.Context, lookup map[string]string) (string, error)
 
 	// DeviceLookup performs a lookup operation based on the provided parameters.
 	DeviceLookup(ctx context.Context, tenantID, name string) (*models.Device, error)
@@ -33,14 +33,17 @@ type deviceAPI interface {
 	LookupWebEndpoints(ctx context.Context, address string) (*WebEndpoint, error)
 }
 
+// ErrDeviceRequestFailed indicates that the device request failed.
+var ErrDeviceRequestFailed = errors.New("device request failed")
+
 func (c *client) DevicesOffline(ctx context.Context, uid string) error {
 	_, err := c.http.
 		R().
 		SetContext(ctx).
 		SetPathParam("uid", uid).
 		Post(c.Config.APIBaseURL + "/internal/devices/{uid}/offline")
 	if err != nil {
-		return err
+		return errors.Join(ErrDeviceRequestFailed, err)
 	}
 
 	return nil
@@ -50,27 +53,37 @@ func (c *client) DevicesHeartbeat(ctx context.Context, uid string) error {
 	return c.worker.SubmitToBatch(ctx, worker.TaskPattern("api:heartbeat"), []byte(uid))
 }
 
-func (c *client) Lookup(ctx context.Context, lookup map[string]string) (string, []error) {
+// ErrLookupFailed indicates that the lookup operation failed.
+var ErrLookupFailed = errors.New("lookup failed")
+
+func (c *client) Lookup(ctx context.Context, lookup map[string]string) (string, error) {
 	var device struct {
 		UID string `json:"uid"`
 	}
 
-	resp, _ := c.http.
+	resp, err := c.http.
 		R().
 		SetContext(ctx).
 		SetQueryParams(lookup).
 		SetResult(&device).
 		Get(c.Config.APIBaseURL + "/internal/lookup")
+	if err != nil {
+		return "", errors.Join(ErrDeviceRequestFailed, err)
+	}
 
 	if resp.StatusCode() != http.StatusOK {
-		return "", []error{errors.New("lookup failed")}
+		return "", ErrLookupFailed
 	}
 
 	return device.UID, nil
 }
 
+// ErrDeviceLookupFailed indicates that the device lookup operation failed.
+var ErrDeviceLookupFailed = errors.New("device lookup failed")
+
 func (c *client) DeviceLookup(ctx context.Context, tenantID, name string) (*models.Device, error) {
 	device := new(models.Device)
+
 	resp, err := c.http.
 		R().
 		SetContext(ctx).
@@ -79,33 +92,41 @@ func (c *client) DeviceLookup(ctx context.Context, tenantID, name string) (*mode
 		SetResult(&device).
 		Get(c.Config.APIBaseURL + "/internal/device/lookup")
 	if err != nil {
-		return nil, ErrConnectionFailed
+		return nil, errors.Join(ErrDeviceRequestFailed, err)
 	}
 
-	switch resp.StatusCode() {
-	case http.StatusOK:
-		return device, nil
-	case http.StatusNotFound:
-		return nil, ErrNotFound
-	case http.StatusForbidden:
-		return nil, ErrForbidden
-	default:
-		return nil, ErrUnknown
+	if resp.StatusCode() != http.StatusOK {
+		return nil, ErrDeviceLookupFailed
 	}
+
+	return device, nil
 }
 
+// ErrListDevicesFailed indicates that the operation to list devices failed.
+var ErrListDevicesFailed = errors.New("list devices failed")
+
 func (c *client) ListDevices(ctx context.Context) ([]models.Device, error) {
 	list := []models.Device{}
 
-	_, err := c.http.
+	resp, err := c.http.
 		R().
 		SetContext(ctx).
 		SetResult(list).
 		Get(c.Config.APIBaseURL + "/api/devices")
+	if err != nil {
+		return nil, errors.Join(ErrDeviceRequestFailed, err)
+	}
+
+	if resp.StatusCode() != http.StatusOK {
+		return nil, ErrListDevicesFailed
+	}
 
-	return list, err
+	return list, nil
 }
 
+// ErrGetDeviceFailed indicates that the operation to get a device failed.
+var ErrGetDeviceFailed = errors.New("get device failed")
+
 func (c *client) GetDevice(ctx context.Context, uid string) (*models.Device, error) {
 	device := new(models.Device)
 	resp, err := c.http.
@@ -114,17 +135,14 @@ func (c *client) GetDevice(ctx context.Context, uid string) (*models.Device, err
 		SetResult(&device).
 		Get(c.Config.APIBaseURL + "/api/devices/{uid}")
 	if err != nil {
-		return nil, ErrConnectionFailed
+		return nil, errors.Join(ErrDeviceRequestFailed, err)
 	}
 
-	switch resp.StatusCode() {
-	case 400:
-		return nil, ErrNotFound
-	case 200:
-		return device, nil
-	default:
-		return nil, ErrUnknown
+	if resp.StatusCode() != http.StatusOK {
+		return nil, ErrGetDeviceFailed
 	}
+
+	return device, nil
 }
 
 type WebEndpoint struct {
@@ -139,26 +157,28 @@ type WebEndpoint struct {
 	CreatedAt  time.Time      `json:"time" bson:"time"`
 }
 
+var (
+	// ErrWebEndpointRequestFailed indicates that the web endpoint request failed.
+	ErrWebEndpointRequestFailed = errors.New("web endpoint request failed")
+	// ErrWebEndpointForbidden indicates that access to the web endpoint is forbidden.
+	ErrWebEndpointForbidden = errors.New("web endpoint access forbidden")
+)
+
 func (c *client) LookupWebEndpoints(ctx context.Context, address string) (*WebEndpoint, error) {
-	var tunnel *WebEndpoint
+	var endpoint *WebEndpoint
 	resp, err := c.http.
 		R().
 		SetContext(ctx).
 		SetPathParam("address", address).
-		SetResult(&tunnel).
+		SetResult(&endpoint).
 		Get(c.Config.EnterpriseBaseURL + "/internal/web-endpoints/{address}")
 	if err != nil {
-		return nil, ErrConnectionFailed
+		return nil, errors.Join(ErrWebEndpointRequestFailed, err)
 	}
 
-	switch resp.StatusCode() {
-	case 404:
-		return nil, ErrNotFound
-	case 403:
-		return nil, ErrForbidden
-	case 200:
-		return tunnel, nil
-	default:
-		return nil, ErrUnknown
+	if resp.StatusCode() != http.StatusOK {
+		return nil, ErrWebEndpointForbidden
 	}
+
+	return endpoint, nil
 }

pkg/api/internalclient/firewall.go

@@ -14,8 +14,10 @@ type firewallAPI interface {
 }
 
 var (
-	ErrFirewallConnection = errors.New("failed to make the request to evaluate the firewall")
-	ErrFirewallBlock      = errors.New("a firewall rule prohibit this connection")
+	// ErrFirewallEvaluationRequest is returned when the firewall evaluation request fails for any reason.
+	ErrFirewallEvaluationRequest = errors.New("failed to evaluate the firewall")
+	// ErrFirewallBlock is returned when a firewall rule prohibits the connection.
+	ErrFirewallBlock = errors.New("a firewall rule prohibit this connection")
 )
 
 func (c *client) FirewallEvaluate(ctx context.Context, lookup map[string]string) error {
@@ -25,7 +27,7 @@ func (c *client) FirewallEvaluate(ctx context.Context, lookup map[string]string)
 		SetQueryParams(lookup).
 		Get(c.Config.EnterpriseBaseURL + "/internal/firewall/rules/evaluate")
 	if err != nil {
-		return ErrFirewallConnection
+		return errors.Join(ErrFirewallEvaluationRequest, err)
 	}
 
 	if resp.StatusCode() != http.StatusOK {

pkg/api/internalclient/mocks/internalclient.go

@@ -2,6 +2,7 @@ package internalclient
 
 import (
 	"context"
+	"errors"
 	"net/http"
 
 	"github.com/shellhub-io/shellhub/pkg/models"
@@ -19,6 +20,13 @@ type namespaceAPI interface {
 	InviteMember(ctx context.Context, tenantID, userID, forwardedHost string) error
 }
 
+var (
+	// ErrNamespaceLookupRequest indicates that the namespace lookup request failed.
+	ErrNamespaceLookupRequest = errors.New("namespace lookup request failed")
+	// ErrNamespaceLookupFailed indicates that the namespace lookup operation failed.
+	ErrNamespaceLookupFailed = errors.New("namespace lookup failed")
+)
+
 func (c *client) NamespaceLookup(ctx context.Context, tenant string) (*models.Namespace, error) {
 	namespace := new(models.Namespace)
 	res, err := c.http.
@@ -28,11 +36,11 @@ func (c *client) NamespaceLookup(ctx context.Context, tenant string) (*models.Na
 		SetResult(namespace).
 		Get(c.Config.APIBaseURL + "/api/namespaces/{tenant}")
 	if err != nil {
-		return nil, err
+		return nil, errors.Join(ErrNamespaceLookupRequest, err)
 	}
 
 	if res.StatusCode() != http.StatusOK {
-		return nil, err
+		return nil, ErrNamespaceLookupFailed
 	}
 
 	return namespace, nil