feat: [#495] Centralize Error Messages in Framework (PR#2) (#666)

* add new errors in auth module

* add custom errors for cache

* add custom errors for console

* add custom errors for crypt

* add custom errors for crypt

* add custom errors for event

* add custom errors for facade

* optimize cache

* add custom errors for filesystem

* add custom errors for filesystem

* add custom errors for hash

* add custom errors for log

* add custom errors for lang

* add custom errors for validation

* add custom errors for testing

* add custom errors for schedule

* add custom errors for route

* add custom errors for queue

* add custom errors for database

* fix:test

* fix:test

* fix:test

* fix:test

* fix:test

* fix:test

* reorder errors message and remove Err prefix

* .

* .

* update cache driver

* update cache driver

* remove unused errors.go

* add errors to support console

* add errors for support/file

Author: kkumar-gcc

auth/auth.go

@@ -1,7 +1,6 @@
 package auth
 
 import (
-	"errors"
 	"strings"
 	"time"
 
@@ -14,6 +13,7 @@ import (
 	"github.com/goravel/framework/contracts/config"
 	"github.com/goravel/framework/contracts/database/orm"
 	"github.com/goravel/framework/contracts/http"
+	"github.com/goravel/framework/errors"
 	"github.com/goravel/framework/support/carbon"
 	"github.com/goravel/framework/support/database"
 )
@@ -58,16 +58,16 @@ func (a *Auth) Guard(name string) contractsauth.Auth {
 func (a *Auth) User(user any) error {
 	auth, ok := a.ctx.Value(ctxKey).(Guards)
 	if !ok || auth[a.guard] == nil {
-		return ErrorParseTokenFirst
+		return errors.AuthParseTokenFirst
 	}
 	if auth[a.guard].Claims == nil {
-		return ErrorParseTokenFirst
+		return errors.AuthParseTokenFirst
 	}
 	if auth[a.guard].Claims.Key == "" {
-		return ErrorInvalidKey
+		return errors.AuthInvalidKey
 	}
 	if auth[a.guard].Token == "" {
-		return ErrorTokenExpired
+		return errors.AuthTokenExpired
 	}
 	if err := a.orm.Query().FindOrFail(user, clause.Eq{Column: clause.PrimaryColumn, Value: auth[a.guard].Claims.Key}); err != nil {
 		return err
@@ -79,10 +79,10 @@ func (a *Auth) User(user any) error {
 func (a *Auth) Id() (string, error) {
 	auth, ok := a.ctx.Value(ctxKey).(Guards)
 	if !ok || auth[a.guard] == nil {
-		return "", ErrorParseTokenFirst
+		return "", errors.AuthParseTokenFirst
 	}
 	if auth[a.guard].Token == "" {
-		return "", ErrorTokenExpired
+		return "", errors.AuthTokenExpired
 	}
 
 	return auth[a.guard].Claims.Key, nil
@@ -91,10 +91,10 @@ func (a *Auth) Id() (string, error) {
 func (a *Auth) Parse(token string) (*contractsauth.Payload, error) {
 	token = strings.ReplaceAll(token, "Bearer ", "")
 	if a.cache == nil {
-		return nil, errors.New("cache support is required")
+		return nil, errors.CacheSupportRequired.SetModule(errors.ModuleAuth)
 	}
 	if a.tokenIsDisabled(token) {
-		return nil, ErrorTokenDisabled
+		return nil, errors.AuthTokenDisabled
 	}
 
 	jwtSecret := a.config.GetString("jwt.secret")
@@ -107,7 +107,7 @@ func (a *Auth) Parse(token string) (*contractsauth.Payload, error) {
 		if errors.Is(err, jwt.ErrTokenExpired) && tokenClaims != nil {
 			claims, ok := tokenClaims.Claims.(*Claims)
 			if !ok {
-				return nil, ErrorInvalidClaims
+				return nil, errors.AuthInvalidClaims
 			}
 
 			a.makeAuthContext(claims, "")
@@ -117,18 +117,18 @@ func (a *Auth) Parse(token string) (*contractsauth.Payload, error) {
 				Key:      claims.Key,
 				ExpireAt: claims.ExpiresAt.Local(),
 				IssuedAt: claims.IssuedAt.Local(),
-			}, ErrorTokenExpired
+			}, errors.AuthTokenExpired
 		}
 
-		return nil, ErrorInvalidToken
+		return nil, errors.AuthInvalidToken
 	}
 	if tokenClaims == nil || !tokenClaims.Valid {
-		return nil, ErrorInvalidToken
+		return nil, errors.AuthInvalidToken
 	}
 
 	claims, ok := tokenClaims.Claims.(*Claims)
 	if !ok {
-		return nil, ErrorInvalidClaims
+		return nil, errors.AuthInvalidClaims
 	}
 
 	a.makeAuthContext(claims, token)
@@ -144,7 +144,7 @@ func (a *Auth) Parse(token string) (*contractsauth.Payload, error) {
 func (a *Auth) Login(user any) (token string, err error) {
 	id := database.GetID(user)
 	if id == nil {
-		return "", ErrorNoPrimaryKeyField
+		return "", errors.AuthNoPrimaryKeyField
 	}
 
 	return a.LoginUsingID(id)
@@ -153,7 +153,7 @@ func (a *Auth) Login(user any) (token string, err error) {
 func (a *Auth) LoginUsingID(id any) (token string, err error) {
 	jwtSecret := a.config.GetString("jwt.secret")
 	if jwtSecret == "" {
-		return "", ErrorEmptySecret
+		return "", errors.AuthEmptySecret
 	}
 
 	nowTime := carbon.Now()
@@ -165,7 +165,7 @@ func (a *Auth) LoginUsingID(id any) (token string, err error) {
 	expireTime := nowTime.AddMinutes(ttl).StdTime()
 	key := cast.ToString(id)
 	if key == "" {
-		return "", ErrorInvalidKey
+		return "", errors.AuthInvalidKey
 	}
 	claims := Claims{
 		key,
@@ -191,10 +191,10 @@ func (a *Auth) LoginUsingID(id any) (token string, err error) {
 func (a *Auth) Refresh() (token string, err error) {
 	auth, ok := a.ctx.Value(ctxKey).(Guards)
 	if !ok || auth[a.guard] == nil {
-		return "", ErrorParseTokenFirst
+		return "", errors.AuthParseTokenFirst
 	}
 	if auth[a.guard].Claims == nil {
-		return "", ErrorParseTokenFirst
+		return "", errors.AuthParseTokenFirst
 	}
 
 	nowTime := carbon.Now()
@@ -206,7 +206,7 @@ func (a *Auth) Refresh() (token string, err error) {
 
 	expireTime := carbon.FromStdTime(auth[a.guard].Claims.ExpiresAt.Time).AddMinutes(refreshTtl)
 	if nowTime.Gt(expireTime) {
-		return "", ErrorRefreshTimeExceeded
+		return "", errors.AuthRefreshTimeExceeded
 	}
 
 	return a.LoginUsingID(auth[a.guard].Claims.Key)
@@ -219,13 +219,13 @@ func (a *Auth) Logout() error {
 	}
 
 	if a.cache == nil {
-		return errors.New("cache support is required")
+		return errors.CacheSupportRequired.SetModule(errors.ModuleAuth)
 	}
 
 	ttl := a.config.GetInt("jwt.ttl")
 	if ttl == 0 {
 		if ok := a.cache.Forever(getDisabledCacheKey(auth[a.guard].Token), true); !ok {
-			return errors.New("cache forever failed")
+			return errors.CacheForeverFailed.SetModule(errors.ModuleAuth)
 		}
 	} else {
 		if err := a.cache.Put(getDisabledCacheKey(auth[a.guard].Token),

auth/auth_test.go

@@ -2,7 +2,6 @@ package auth
 
 import (
 	"context"
-	"errors"
 	"sync"
 	"testing"
 	"time"
@@ -15,6 +14,7 @@ import (
 	authcontract "github.com/goravel/framework/contracts/auth"
 	"github.com/goravel/framework/contracts/http"
 	"github.com/goravel/framework/database/orm"
+	"github.com/goravel/framework/errors"
 	cachemock "github.com/goravel/framework/mocks/cache"
 	configmock "github.com/goravel/framework/mocks/config"
 	ormmock "github.com/goravel/framework/mocks/database/orm"
@@ -117,7 +117,7 @@ func (s *AuthTestSuite) TestLoginUsingID_EmptySecret() {
 
 	token, err := s.auth.LoginUsingID(1)
 	s.Empty(token)
-	s.ErrorIs(err, ErrorEmptySecret)
+	s.ErrorIs(err, errors.AuthEmptySecret)
 
 	s.mockConfig.AssertExpectations(s.T())
 }
@@ -128,7 +128,7 @@ func (s *AuthTestSuite) TestLoginUsingID_InvalidKey() {
 
 	token, err := s.auth.LoginUsingID("")
 	s.Empty(token)
-	s.ErrorIs(err, ErrorInvalidKey)
+	s.ErrorIs(err, errors.AuthInvalidKey)
 
 	s.mockConfig.AssertExpectations(s.T())
 }
@@ -198,7 +198,7 @@ func (s *AuthTestSuite) TestLogin_ErrorModel() {
 	errorUser.Name = "Goravel"
 	token, err := s.auth.Login(&errorUser)
 	s.Empty(token)
-	s.EqualError(err, "the primaryKey field was not found in the model, set primaryKey like orm.Model")
+	s.EqualError(err, errors.AuthNoPrimaryKeyField.Error())
 }
 
 func (s *AuthTestSuite) TestLogin_NoPrimaryKey() {
@@ -212,7 +212,7 @@ func (s *AuthTestSuite) TestLogin_NoPrimaryKey() {
 	user.Name = "Goravel"
 	token, err := s.auth.Login(&user)
 	s.Empty(token)
-	s.ErrorIs(err, ErrorNoPrimaryKeyField)
+	s.ErrorIs(err, errors.AuthNoPrimaryKeyField)
 }
 
 func (s *AuthTestSuite) TestParse_TokenDisabled() {
@@ -221,7 +221,7 @@ func (s *AuthTestSuite) TestParse_TokenDisabled() {
 
 	payload, err := s.auth.Parse(token)
 	s.Nil(payload)
-	s.EqualError(err, "token is disabled")
+	s.EqualError(err, errors.AuthTokenDisabled.Error())
 }
 
 func (s *AuthTestSuite) TestParse_TokenInvalid() {
@@ -260,7 +260,7 @@ func (s *AuthTestSuite) TestParse_TokenExpired() {
 		ExpireAt: jwt.NewNumericDate(expireAt).Local(),
 		IssuedAt: jwt.NewNumericDate(issuedAt).Local(),
 	}, payload)
-	s.ErrorIs(err, ErrorTokenExpired)
+	s.ErrorIs(err, errors.AuthTokenExpired)
 
 	carbon.UnsetTestNow()
 
@@ -271,7 +271,7 @@ func (s *AuthTestSuite) TestParse_InvalidCache() {
 	auth := NewAuth(testUserGuard, nil, s.mockConfig, s.mockContext, s.mockOrm)
 	payload, err := auth.Parse("1")
 	s.Nil(payload)
-	s.EqualError(err, "cache support is required")
+	s.EqualError(err, errors.CacheSupportRequired.SetModule(errors.ModuleAuth).Error())
 }
 
 func (s *AuthTestSuite) TestParse_Success() {
@@ -326,15 +326,15 @@ func (s *AuthTestSuite) TestParse_ExpiredAndInvalid() {
 	s.mockCache.On("GetBool", "jwt:disabled:"+token, false).Return(false).Once()
 
 	_, err := s.auth.Parse(token)
-	s.ErrorIs(err, ErrorInvalidToken)
+	s.ErrorIs(err, errors.AuthInvalidToken)
 
 	s.mockConfig.AssertExpectations(s.T())
 }
 
 func (s *AuthTestSuite) TestUser_NoParse() {
 	var user User
 	err := s.auth.User(user)
-	s.EqualError(err, "parse token first")
+	s.EqualError(err, errors.AuthParseTokenFirst.Error())
 
 	s.mockConfig.AssertExpectations(s.T())
 }
@@ -380,7 +380,7 @@ func (s *AuthTestSuite) TestID_TokenExpired() {
 
 	// Parse the token
 	_, err = s.auth.Parse(token)
-	s.ErrorIs(err, ErrorTokenExpired)
+	s.ErrorIs(err, errors.AuthTokenExpired)
 
 	// Now, call the ID method and expect it to return an empty value
 	id, _ := s.auth.Id()
@@ -397,7 +397,7 @@ func (s *AuthTestSuite) TestID_TokenInvalid() {
 	s.mockCache.On("GetBool", "jwt:disabled:"+token, false).Return(false).Once()
 
 	_, err := s.auth.Parse(token)
-	s.ErrorIs(err, ErrorInvalidToken)
+	s.ErrorIs(err, errors.AuthInvalidToken)
 
 	id, _ := s.auth.Id()
 	s.Empty(id)
@@ -441,11 +441,11 @@ func (s *AuthTestSuite) TestUser_Expired() {
 
 	payload, err := s.auth.Parse(token)
 	s.NotNil(payload)
-	s.ErrorIs(err, ErrorTokenExpired)
+	s.ErrorIs(err, errors.AuthTokenExpired)
 
 	var user User
 	err = s.auth.User(&user)
-	s.EqualError(err, "token expired")
+	s.EqualError(err, errors.AuthTokenExpired.Error())
 
 	s.mockConfig.On("GetInt", "jwt.refresh_ttl").Return(2).Once()
 
@@ -478,19 +478,19 @@ func (s *AuthTestSuite) TestUser_RefreshExpired() {
 
 	payload, err := s.auth.Parse(token)
 	s.NotNil(payload)
-	s.ErrorIs(err, ErrorTokenExpired)
+	s.ErrorIs(err, errors.AuthTokenExpired)
 
 	var user User
 	err = s.auth.User(&user)
-	s.EqualError(err, "token expired")
+	s.EqualError(err, errors.AuthTokenExpired.Error())
 
 	s.mockConfig.On("GetInt", "jwt.refresh_ttl").Return(1).Once()
 
 	carbon.SetTestNow(carbon.Now().AddMinutes(2))
 
 	token, err = s.auth.Refresh()
 	s.Empty(token)
-	s.EqualError(err, "refresh time exceeded")
+	s.EqualError(err, errors.AuthRefreshTimeExceeded.Error())
 
 	carbon.UnsetTestNow()
 
@@ -577,7 +577,7 @@ func (s *AuthTestSuite) TestUser_Success_MultipleParse() {
 func (s *AuthTestSuite) TestRefresh_NotParse() {
 	token, err := s.auth.Refresh()
 	s.Empty(token)
-	s.EqualError(err, "parse token first")
+	s.EqualError(err, errors.AuthParseTokenFirst.Error())
 
 	s.mockConfig.AssertExpectations(s.T())
 }
@@ -602,7 +602,7 @@ func (s *AuthTestSuite) TestRefresh_RefreshTimeExceeded() {
 
 	token, err = s.auth.Refresh()
 	s.Empty(token)
-	s.EqualError(err, "refresh time exceeded")
+	s.EqualError(err, errors.AuthRefreshTimeExceeded.Error())
 
 	carbon.UnsetTestNow()
 
@@ -653,7 +653,7 @@ func (s *AuthTestSuite) TestLogout_CacheUnsupported() {
 	token, err := s.auth.LoginUsingID(1)
 	s.NotEmpty(token)
 	s.Nil(err)
-	s.EqualError(s.auth.Logout(), "cache support is required")
+	s.EqualError(s.auth.Logout(), errors.CacheSupportRequired.SetModule(errors.ModuleAuth).Error())
 
 	s.mockConfig.AssertExpectations(s.T())
 }
@@ -740,7 +740,7 @@ func (s *AuthTestSuite) TestLogout_Error_TTL_Is_0() {
 
 	s.mockCache.On("Forever", testifymock.Anything, true).Return(false).Once()
 
-	s.EqualError(s.auth.Logout(), "cache forever failed")
+	s.EqualError(s.auth.Logout(), errors.CacheForeverFailed.SetModule(errors.ModuleAuth).Error())
 
 	s.mockConfig.AssertExpectations(s.T())
 }