Moved PollUpdateSignup function to common package

pkg/signup/service/signup_service.go

@@ -350,7 +350,7 @@ func (s *ServiceImpl) DoGetSignup(ctx *gin.Context, provider ResourceProvider, u
 	var userSignup *toolchainv1alpha1.UserSignup
 	var err error
 
-	err = pollUpdateSignup(ctx, func() error {
+	err = signup.PollUpdateSignup(ctx, func() error {
 		// Retrieve UserSignup resource from the host cluster, using the specified UserID and username
 		var getError error
 		userSignup, getError = s.DoGetUserSignupFromIdentifier(provider, userID, username)
@@ -621,30 +621,3 @@ func getAppsURL(appRouteName string, signup signup.Signup) string {
 	appsURL := signup.ConsoleURL[index:]
 	return fmt.Sprintf("https://%s%s", appRouteName, appsURL)
 }
-
-func pollUpdateSignup(ctx *gin.Context, updater func() error) error {
-	// Attempt to execute an update function, retrying a number of times if the update fails
-	attempts := 0
-	for {
-		attempts++
-
-		// Attempt the update
-		updateErr := updater()
-
-		// If there was an error, then only log it for now
-		if updateErr != nil {
-			log.Error(ctx, updateErr, fmt.Sprintf("error while executing updating, attempt #%d", attempts))
-		} else {
-			// Otherwise if there was no error executing the update, then break here
-			break
-		}
-
-		// If we've exceeded the number of attempts, then return a useful error to the user.  We won't return the actual
-		// error to the user here, as we've already logged it
-		if attempts > 4 {
-			return updateErr
-		}
-	}
-
-	return nil
-}

pkg/signup/signup.go

@@ -1,5 +1,11 @@
 package signup
 
+import (
+	"fmt"
+	"github.com/codeready-toolchain/registration-service/pkg/log"
+	"github.com/gin-gonic/gin"
+)
+
 // Signup represents Signup resource which is a wrapper of K8s UserSignup
 // and the corresponding MasterUserRecord resources.
 type Signup struct {
@@ -49,3 +55,32 @@ type Status struct {
 	// Default value is false.
 	VerificationRequired bool `json:"verificationRequired"`
 }
+
+// PollUpdateSignup will attempt to execute the provided updater function, and if it fails
+// will reattempt the update for a limited number of retries
+func PollUpdateSignup(ctx *gin.Context, updater func() error) error {
+	// Attempt to execute an update function, retrying a number of times if the update fails
+	attempts := 0
+	for {
+		attempts++
+
+		// Attempt the update
+		updateErr := updater()
+
+		// If there was an error, then only log it for now
+		if updateErr != nil {
+			log.Error(ctx, updateErr, fmt.Sprintf("error while executing updating, attempt #%d", attempts))
+		} else {
+			// Otherwise if there was no error executing the update, then break here
+			break
+		}
+
+		// If we've exceeded the number of attempts, then return a useful error to the user.  We won't return the actual
+		// error to the user here, as we've already logged it
+		if attempts > 4 {
+			return updateErr
+		}
+	}
+
+	return nil
+}

pkg/verification/service/verification_service.go

@@ -4,6 +4,7 @@ import (
 	"crypto/rand"
 	"errors"
 	"fmt"
+	signup2 "github.com/codeready-toolchain/registration-service/pkg/signup"
 	"net/http"
 	"strconv"
 	"time"
@@ -184,7 +185,7 @@ func (s *ServiceImpl) InitVerification(ctx *gin.Context, userID, username, e164P
 		return nil
 	}
 
-	updateErr := pollUpdateSignup(ctx, doUpdate)
+	updateErr := signup2.PollUpdateSignup(ctx, doUpdate)
 	if updateErr != nil {
 		return updateErr
 	}
@@ -311,7 +312,7 @@ func (s *ServiceImpl) VerifyPhoneCode(ctx *gin.Context, userID, username, code s
 		return nil
 	}
 
-	updateErr := pollUpdateSignup(ctx, doUpdate)
+	updateErr := signup2.PollUpdateSignup(ctx, doUpdate)
 	if updateErr != nil {
 		return updateErr
 	}
@@ -366,7 +367,7 @@ func (s *ServiceImpl) VerifyActivationCode(ctx *gin.Context, userID, username, c
 
 			return nil
 		}
-		if err := pollUpdateSignup(ctx, doUpdate); err != nil {
+		if err := signup2.PollUpdateSignup(ctx, doUpdate); err != nil {
 			log.Errorf(ctx, err, "unable to update user signup after validating activation code")
 		}
 	}()
@@ -422,32 +423,3 @@ func checkAttempts(signup *toolchainv1alpha1.UserSignup) (int, error) {
 	}
 	return attemptsMade, nil
 }
-
-func pollUpdateSignup(ctx *gin.Context, updater func() error) error {
-	// Attempt to execute an update function, retrying a number of times if the update fails
-	attempts := 0
-	for {
-		attempts++
-
-		// Attempt the update
-		updateErr := updater()
-
-		// If there was an error, then only log it for now
-		if updateErr != nil {
-			log.Error(ctx, updateErr, fmt.Sprintf("error while executing updating, attempt #%d", attempts))
-		} else {
-			// Otherwise if there was no error executing the update, then break here
-			break
-		}
-
-		// If we've exceeded the number of attempts, then return a useful error to the user.  We won't return the actual
-		// error to the user here, as we've already logged it
-		if attempts > 4 {
-			return crterrors.NewInternalError(errors.New("there was an error while updating your account - please wait a moment before trying again."+
-				" If this error persists, please contact the Developer Sandbox team at devsandbox@redhat.com for assistance"),
-				"error while verifying phone code")
-		}
-	}
-
-	return nil
-}