Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add carbon #177

Merged
merged 21 commits into from
Jun 12, 2023
Merged

feat: add carbon #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
8b3e664
feat: add carbon
devhaozi Jun 10, 2023
6986e54
fix: lint
devhaozi Jun 10, 2023
1390fdc
fix: tests timezone
devhaozi Jun 10, 2023
9bfd315
fix: tests
devhaozi Jun 10, 2023
432cf5a
refactor: move carbon to root dir
devhaozi Jun 11, 2023
e499e6b
fix: tests
devhaozi Jun 11, 2023
c981129
fix: tests
devhaozi Jun 11, 2023
a49638b
fix: tests
devhaozi Jun 11, 2023
a193c7f
feat: optimize code
devhaozi Jun 11, 2023
3d68c5f
feat: optimize code
devhaozi Jun 11, 2023
7008ac0
update
devhaozi Jun 11, 2023
d5be874
Merge branch 'master' into haozi/add-carbon
devhaozi Jun 11, 2023
b74f85b
feat: add carbon mapping
devhaozi Jun 11, 2023
c8be96a
fix: lint
devhaozi Jun 11, 2023
9054df9
fix: tests
devhaozi Jun 12, 2023
7fec5ba
fix: tests
devhaozi Jun 12, 2023
3d3b3fc
feat: update tests
devhaozi Jun 12, 2023
d603e8d
fix: time
devhaozi Jun 12, 2023
a53f64f
feat: optimize code
devhaozi Jun 12, 2023
98b157d
fix: tests
devhaozi Jun 12, 2023
dca85d8
fix: tests
devhaozi Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions auth/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,17 @@ import (
"github.com/spf13/cast"
"gorm.io/gorm/clause"

"github.com/goravel/framework/carbon"
contractsauth "github.com/goravel/framework/contracts/auth"
"github.com/goravel/framework/contracts/cache"
"github.com/goravel/framework/contracts/config"
"github.com/goravel/framework/contracts/database/orm"
"github.com/goravel/framework/contracts/http"
"github.com/goravel/framework/support/database"
supporttime "github.com/goravel/framework/support/time"
)

const ctxKey = "GoravelAuth"

var (
unit = time.Minute
)

type Claims struct {
Key string `json:"key"`
jwt.RegisteredClaims
Expand All @@ -44,7 +40,9 @@ type Auth struct {
}

func NewAuth(guard string, cache cache.Cache, config config.Config, orm orm.Orm) *Auth {
jwt.TimeFunc = supporttime.Now
jwt.TimeFunc = func() time.Time {
return carbon.Now().ToStdTime()
}

return &Auth{
cache: cache,
Expand All @@ -58,7 +56,7 @@ func (a *Auth) Guard(name string) contractsauth.Auth {
return NewAuth(name, a.cache, a.config, a.orm)
}

//User need parse token first.
// User need parse token first.
func (a *Auth) User(ctx http.Context, user any) error {
auth, ok := ctx.Value(ctxKey).(Guards)
if !ok || auth[a.guard] == nil {
Expand Down Expand Up @@ -146,9 +144,9 @@ func (a *Auth) LoginUsingID(ctx http.Context, id any) (token string, err error)
return "", ErrorEmptySecret
}

nowTime := supporttime.Now()
nowTime := carbon.Now()
ttl := a.config.GetInt("jwt.ttl")
expireTime := nowTime.Add(time.Duration(ttl) * unit)
expireTime := nowTime.AddMinutes(ttl).ToStdTime()
key := cast.ToString(id)
if key == "" {
return "", ErrorInvalidKey
Expand All @@ -157,7 +155,7 @@ func (a *Auth) LoginUsingID(ctx http.Context, id any) (token string, err error)
key,
jwt.RegisteredClaims{
ExpiresAt: jwt.NewNumericDate(expireTime),
IssuedAt: jwt.NewNumericDate(nowTime),
IssuedAt: jwt.NewNumericDate(nowTime.ToStdTime()),
Subject: a.guard,
},
}
Expand All @@ -173,7 +171,7 @@ func (a *Auth) LoginUsingID(ctx http.Context, id any) (token string, err error)
return
}

//Refresh need parse token first.
// Refresh need parse token first.
func (a *Auth) Refresh(ctx http.Context) (token string, err error) {
auth, ok := ctx.Value(ctxKey).(Guards)
if !ok || auth[a.guard] == nil {
Expand All @@ -183,10 +181,10 @@ func (a *Auth) Refresh(ctx http.Context) (token string, err error) {
return "", ErrorParseTokenFirst
}

nowTime := supporttime.Now()
nowTime := carbon.Now()
refreshTtl := a.config.GetInt("jwt.refresh_ttl")
expireTime := auth[a.guard].Claims.ExpiresAt.Add(time.Duration(refreshTtl) * unit)
if nowTime.Unix() > expireTime.Unix() {
expireTime := carbon.FromStdTime(auth[a.guard].Claims.ExpiresAt.Time).AddMinutes(refreshTtl)
if nowTime.Gt(expireTime) {
devhaozi marked this conversation as resolved.
Show resolved Hide resolved
return "", ErrorRefreshTimeExceeded
}

Expand All @@ -205,7 +203,7 @@ func (a *Auth) Logout(ctx http.Context) error {

if err := a.cache.Put(getDisabledCacheKey(auth[a.guard].Token),
true,
time.Duration(a.config.GetInt("jwt.ttl"))*unit,
time.Duration(a.config.GetInt("jwt.ttl"))*time.Minute,
); err != nil {
return err
}
Expand Down
49 changes: 31 additions & 18 deletions auth/auth_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ import (
"github.com/stretchr/testify/suite"
"gorm.io/gorm/clause"

"github.com/goravel/framework/carbon"
authcontract "github.com/goravel/framework/contracts/auth"
cachemock "github.com/goravel/framework/contracts/cache/mocks"
configmock "github.com/goravel/framework/contracts/config/mocks"
ormmock "github.com/goravel/framework/contracts/database/orm/mocks"
"github.com/goravel/framework/database/orm"
"github.com/goravel/framework/http"
supporttime "github.com/goravel/framework/support/time"
)

var guard = "user"
Expand All @@ -36,8 +36,6 @@ type AuthTestSuite struct {
}

func TestAuthTestSuite(t *testing.T) {
unit = time.Second

suite.Run(t, new(AuthTestSuite))
}

Expand Down Expand Up @@ -173,24 +171,29 @@ func (s *AuthTestSuite) TestParse_TokenExpired() {
s.mockConfig.On("GetString", "jwt.secret").Return("Goravel").Twice()
s.mockConfig.On("GetInt", "jwt.ttl").Return(2).Once()

now := supporttime.Now()
ctx := http.Background()

now := carbon.Now()
issuedAt := now.ToStdTime()
expireAt := now.AddMinutes(2).ToStdTime()
token, err := s.auth.LoginUsingID(ctx, 1)
s.Nil(err)

time.Sleep(2 * unit)
carbon.SetTestNow(now.AddMinutes(2))

s.mockCache.On("GetBool", "jwt:disabled:"+token, false).Return(false).Once()

payload, err := s.auth.Parse(ctx, token)
s.Equal(&authcontract.Payload{
Guard: guard,
Key: "1",
ExpireAt: jwt.NewNumericDate(now.Add(time.Duration(2) * unit)).Local(),
IssuedAt: jwt.NewNumericDate(now).Local(),
ExpireAt: jwt.NewNumericDate(expireAt).Local(),
IssuedAt: jwt.NewNumericDate(issuedAt).Local(),
}, payload)
s.ErrorIs(err, ErrorTokenExpired)

carbon.UnsetTestNow()

s.mockConfig.AssertExpectations(s.T())
}

Expand All @@ -216,8 +219,8 @@ func (s *AuthTestSuite) TestParse_Success() {
s.Equal(&authcontract.Payload{
Guard: guard,
Key: "1",
ExpireAt: jwt.NewNumericDate(supporttime.Now().Add(time.Duration(2) * unit)).Local(),
IssuedAt: jwt.NewNumericDate(supporttime.Now()).Local(),
ExpireAt: jwt.NewNumericDate(carbon.Now().AddMinutes(2).ToStdTime()).Local(),
IssuedAt: jwt.NewNumericDate(carbon.Now().ToStdTime()).Local(),
}, payload)
s.Nil(err)

Expand All @@ -238,8 +241,8 @@ func (s *AuthTestSuite) TestParse_SuccessWithPrefix() {
s.Equal(&authcontract.Payload{
Guard: guard,
Key: "1",
ExpireAt: jwt.NewNumericDate(supporttime.Now().Add(time.Duration(2) * unit)).Local(),
IssuedAt: jwt.NewNumericDate(supporttime.Now()).Local(),
ExpireAt: jwt.NewNumericDate(carbon.Now().AddMinutes(2).ToStdTime()).Local(),
IssuedAt: jwt.NewNumericDate(carbon.Now().ToStdTime()).Local(),
}, payload)
s.Nil(err)

Expand Down Expand Up @@ -291,7 +294,7 @@ func (s *AuthTestSuite) TestUser_Expired() {

s.mockCache.On("GetBool", "jwt:disabled:"+token, false).Return(false).Once()

time.Sleep(2 * unit)
carbon.SetTestNow(carbon.Now().AddMinutes(2))

payload, err := s.auth.Parse(ctx, token)
s.NotNil(payload)
Expand All @@ -313,6 +316,8 @@ func (s *AuthTestSuite) TestUser_Expired() {
err = s.auth.User(ctx, &user)
s.Nil(err)

carbon.UnsetTestNow()

s.mockConfig.AssertExpectations(s.T())
}

Expand All @@ -327,7 +332,7 @@ func (s *AuthTestSuite) TestUser_RefreshExpired() {

s.mockCache.On("GetBool", "jwt:disabled:"+token, false).Return(false).Once()

time.Sleep(2 * unit)
carbon.SetTestNow(carbon.Now().AddMinutes(2))

payload, err := s.auth.Parse(ctx, token)
s.NotNil(payload)
Expand All @@ -339,12 +344,14 @@ func (s *AuthTestSuite) TestUser_RefreshExpired() {

s.mockConfig.On("GetInt", "jwt.refresh_ttl").Return(1).Once()

time.Sleep(2 * unit)
carbon.SetTestNow(carbon.Now().AddMinutes(2))

token, err = s.auth.Refresh(ctx)
s.Empty(token)
s.EqualError(err, "refresh time exceeded")

carbon.UnsetTestNow()

s.mockConfig.AssertExpectations(s.T())
}

Expand Down Expand Up @@ -397,12 +404,15 @@ func (s *AuthTestSuite) TestRefresh_RefreshTimeExceeded() {
s.Nil(err)

s.mockConfig.On("GetInt", "jwt.refresh_ttl").Return(1).Once()
time.Sleep(4 * unit)

carbon.SetTestNow(carbon.Now().AddMinutes(4))

token, err = s.auth.Refresh(ctx)
s.Empty(token)
s.EqualError(err, "refresh time exceeded")

carbon.UnsetTestNow()

s.mockConfig.AssertExpectations(s.T())
}

Expand All @@ -421,12 +431,15 @@ func (s *AuthTestSuite) TestRefresh_Success() {
s.Nil(err)

s.mockConfig.On("GetInt", "jwt.refresh_ttl").Return(1).Once()
time.Sleep(2 * unit)

carbon.SetTestNow(carbon.Now().AddMinutes(2))

token, err = s.auth.Refresh(ctx)
s.NotEmpty(token)
s.Nil(err)

carbon.UnsetTestNow()

s.mockConfig.AssertExpectations(s.T())
}

Expand Down Expand Up @@ -462,7 +475,7 @@ func (s *AuthTestSuite) TestLogout_SetDisabledCacheError() {
s.NotNil(payload)
s.Nil(err)

s.mockCache.On("Put", testifymock.Anything, true, 2*unit).Return(errors.New("error")).Once()
s.mockCache.On("Put", testifymock.Anything, true, 2*time.Minute).Return(errors.New("error")).Once()

s.EqualError(s.auth.Logout(ctx), "error")

Expand All @@ -484,7 +497,7 @@ func (s *AuthTestSuite) TestLogout_Success() {
s.NotNil(payload)
s.Nil(err)

s.mockCache.On("Put", testifymock.Anything, true, 2*unit).Return(nil).Once()
s.mockCache.On("Put", testifymock.Anything, true, 2*time.Minute).Return(nil).Once()

s.Nil(s.auth.Logout(ctx))

Expand Down
Loading