chore(request_2fa_token): return push status (#58)

In request_2fa_token endpoint, return status of push notification for
each connected device.

Author: krzysztofdrys

internal/api/browser_extension/app/command/request_2fa_token.go

@@ -10,13 +10,23 @@ import (
 	"github.com/avast/retry-go/v4"
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
+
 	"github.com/twofas/2fas-server/internal/api/browser_extension/domain"
 	"github.com/twofas/2fas-server/internal/common/logging"
 	"github.com/twofas/2fas-server/internal/common/push"
 )
 
 var tokenPushNotificationTtl = time.Minute * 3
 
+type PushNotificationStatus string
+
+const (
+	PushNotificationStatusOK           = "ok"
+	PushNotificationStatusNoFCM        = "no_fcm"
+	PushNotificationStatusError        = "error"
+	PushNotificationStatusUnregistered = "unregistered"
+)
+
 type Request2FaTokenPushNotification struct {
 	ExtensionId  string `json:"extension_id"`
 	IssuerDomain string `json:"issuer_domain"`
@@ -58,23 +68,21 @@ type Request2FaTokenHandler struct {
 	Pusher                               push.Pusher
 }
 
-func (h *Request2FaTokenHandler) Handle(ctx context.Context, cmd *Request2FaToken) error {
+func (h *Request2FaTokenHandler) Handle(ctx context.Context, cmd *Request2FaToken) (map[string]PushNotificationStatus, error) {
 	log := logging.FromContext(ctx)
 	extId, _ := uuid.Parse(cmd.ExtensionId)
 
 	browserExtension, err := h.BrowserExtensionsRepository.FindById(extId)
-
 	if err != nil {
-		return err
+		return nil, err
 	}
 
 	tokenRequestId, _ := uuid.Parse(cmd.Id)
 	browserExtension2FaRequest := domain.NewBrowserExtension2FaRequest(tokenRequestId, browserExtension.Id, cmd.Domain)
 
 	err = h.BrowserExtension2FaRequestRepository.Save(browserExtension2FaRequest)
-
 	if err != nil {
-		return err
+		return nil, err
 	}
 
 	pairedDevices := h.PairedDevicesRepository.FindAll(browserExtension.Id)
@@ -86,6 +94,8 @@ func (h *Request2FaTokenHandler) Handle(ctx context.Context, cmd *Request2FaToke
 		"type":         "browser_extension_request",
 	}
 
+	result := map[string]PushNotificationStatus{}
+
 	for _, device := range pairedDevices {
 		if device.FcmToken == "" {
 			log.WithFields(logging.Fields{
@@ -96,6 +106,7 @@ func (h *Request2FaTokenHandler) Handle(ctx context.Context, cmd *Request2FaToke
 				"platform":         device.Platform,
 				"type":             "browser_extension_request",
 			}).Info("Cannot send push notification, missing FCM token")
+			result[device.Id.String()] = PushNotificationStatusNoFCM
 			continue
 		}
 
@@ -116,8 +127,12 @@ func (h *Request2FaTokenHandler) Handle(ctx context.Context, cmd *Request2FaToke
 			retry.Attempts(5),
 			retry.LastErrorOnly(true),
 		)
-
-		if err != nil && !messaging.IsUnregistered(err) {
+		if err == nil {
+			result[device.Id.String()] = PushNotificationStatusOK
+		} else if messaging.IsUnregistered(err) {
+			result[device.Id.String()] = PushNotificationStatusUnregistered
+		} else {
+			result[device.Id.String()] = PushNotificationStatusError
 			log.WithFields(logging.Fields{
 				"extension_id":     extId.String(),
 				"device_id":        device.Id.String(),
@@ -130,7 +145,7 @@ func (h *Request2FaTokenHandler) Handle(ctx context.Context, cmd *Request2FaToke
 		}
 	}
 
-	return nil
+	return result, nil
 }
 
 func createPushNotificationForIos(token string, data map[string]interface{}) *messaging.Message {

internal/api/browser_extension/ports/http.go

@@ -5,14 +5,15 @@ import (
 	"github.com/go-playground/validator/v10"
 	"github.com/google/uuid"
 	"github.com/pkg/errors"
+	"gorm.io/gorm"
+
 	"github.com/twofas/2fas-server/internal/api/browser_extension/adapters"
 	"github.com/twofas/2fas-server/internal/api/browser_extension/app"
 	"github.com/twofas/2fas-server/internal/api/browser_extension/app/command"
 	"github.com/twofas/2fas-server/internal/api/browser_extension/app/query"
 	"github.com/twofas/2fas-server/internal/api/browser_extension/domain"
 	"github.com/twofas/2fas-server/internal/common/api"
 	"github.com/twofas/2fas-server/internal/common/logging"
-	"gorm.io/gorm"
 )
 
 type RoutesHandler struct {
@@ -311,8 +312,7 @@ func (r *RoutesHandler) Request2FaToken(c *gin.Context) {
 		return
 	}
 
-	err = r.cqrs.Commands.Request2FaToken.Handle(c.Request.Context(), cmd)
-
+	pushResult, err := r.cqrs.Commands.Request2FaToken.Handle(c.Request.Context(), cmd)
 	if err != nil {
 		c.JSON(500, api.NewInternalServerError(err))
 
@@ -325,13 +325,21 @@ func (r *RoutesHandler) Request2FaToken(c *gin.Context) {
 	}
 
 	result, err := r.cqrs.Queries.BrowserExtension2FaRequestQuery.Handle(q)
-
 	if err != nil {
 		c.JSON(500, api.NewInternalServerError(err))
 		return
 	}
 
-	c.JSON(200, result[0])
+	var jsonResult struct {
+		query.BrowserExtension2FaRequestPresenter
+		PushStatus map[string]command.PushNotificationStatus `json:"push_status"`
+	}
+	if len(result) >= 0 && result[0] != nil {
+		jsonResult.BrowserExtension2FaRequestPresenter = *result[0]
+	}
+	jsonResult.PushStatus = pushResult
+
+	c.JSON(200, jsonResult)
 }
 
 func (r *RoutesHandler) Close2FaRequest(c *gin.Context) {