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

Jump to bottom

Removed deprecated functions in the auth/rememberme package. #30

Merged
merged 2 commits into from
Apr 6, 2022
Merged

Removed deprecated functions in the auth/rememberme package. #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bf6b4e
Removed deprecated functions in the auth/rememberme package.
qqiao Apr 6, 2022
82d72cb
Merge branch 'main' into remove-deprecated-in-rememberme
qqiao Apr 6, 2022
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
212 changes: 60 additions & 152 deletions auth/rememberme/firebase_token_manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,6 @@ type FirebaseTokenManager struct {
collectionName string
}

// NewTokenManager creates a token manager with the given firestore client
// and collection name to store the rememberme tokens in.
//
// Deprecated: Please use NewFirebaseTokenManager instead.
func NewTokenManager(client *firestore.Client, collectionName string) FirebaseTokenManager {
return NewFirebaseTokenManager(client, collectionName)
}

// NewFirebaseTokenManager creates a token manager with the given firestore
// client and collection name to store the rememberme tokens in.
func NewFirebaseTokenManager(client *firestore.Client,
Expand All @@ -49,6 +41,66 @@ func NewFirebaseTokenManager(client *firestore.Client,
}
}

// Add adds the token to the underlying datastore
//
// This function will return ErrTokenDuplicate if the given Username
// Identifier combination already exists in the datastore
func (m FirebaseTokenManager) Add(ctx context.Context,
token Token) (<-chan *Token, <-chan error) {
tokenCh := make(chan *Token)
errCh := make(chan error)

go func() {
defer close(tokenCh)
defer close(errCh)

now := time.Now().Unix()
token.Created = now
token.LastUsed = now
token.Revoked = false

if err := m.client.RunTransaction(ctx, func(ctx context.Context,
t *firestore.Transaction) error {
q := f.ApplyQuery(m.client.Collection(m.collectionName),
datastore.Query{
Filters: []datastore.Filter{
{
Path: "Username",
Operator: "==",
Value: token.Username,
},
{
Path: "Identifier",
Operator: "==",
Value: token.Identifier,
},
},
})

iter := q.Documents(ctx)
defer iter.Stop()

_, err := iter.Next()
if err != iterator.Done {
return ErrTokenDuplicate
}

doc := m.client.Collection(m.collectionName).NewDoc()
if err = t.Set(doc, token); err != nil {
return err
}
return nil

}); err != nil {
errCh <- err
return
}
tokenCh <- &token
}()

return tokenCh, errCh
}

// Delete deletes the token permanently from the underlying datastore.
//
// Once deleted, a token cannot be recovered
Expand Down Expand Up @@ -157,18 +209,6 @@ func (m FirebaseTokenManager) Purge(ctx context.Context, username string,
return errCh
}

// PurgeTokens removes tokens belonging to a given user last used before or
// equal to the cutoff time.
//
// This function DELETES all matching tokens, regardless of whether the token
// has been revoked.
//
// Deprecated: please use method Purge instead
func (m FirebaseTokenManager) PurgeTokens(ctx context.Context, username string,
cutoff time.Time) <-chan error {
return m.Purge(ctx, username, cutoff)
}

// Revoke revokes a given token by marking the Revoked field to true.
//
// Although both revoking a token and removing a token will make the
Expand Down Expand Up @@ -231,112 +271,6 @@ func (m FirebaseTokenManager) Revoke(ctx context.Context,
return tokenCh, errCh
}

// RevokeToken revokes a given token by marking the Revoked field to true.
//
// Although both revoking a token and removing a token will make the
// ValidateToken call fail, RevokeToken leaves the token stored in the data
// store.
//
// Deprecated: please use Revoke instead
func (m FirebaseTokenManager) RevokeToken(ctx context.Context,
token Token) <-chan error {
t, e := m.Revoke(ctx, token)
errCh := make(chan error)

go func() {
defer close(errCh)

select {
case err := <-e:
errCh <- err

case <-t:
}
}()
return errCh
}

// Add adds the token to the underlying datastore
//
// This function will return ErrTokenDuplicate if the given Username
// Identifier combination already exists in the datastore
func (m FirebaseTokenManager) Add(ctx context.Context,
token Token) (<-chan *Token, <-chan error) {
tokenCh := make(chan *Token)
errCh := make(chan error)

go func() {
defer close(tokenCh)
defer close(errCh)

now := time.Now().Unix()
token.Created = now
token.LastUsed = now
token.Revoked = false

if err := m.client.RunTransaction(ctx, func(ctx context.Context,
t *firestore.Transaction) error {
q := f.ApplyQuery(m.client.Collection(m.collectionName),
datastore.Query{
Filters: []datastore.Filter{
{
Path: "Username",
Operator: "==",
Value: token.Username,
},
{
Path: "Identifier",
Operator: "==",
Value: token.Identifier,
},
},
})

iter := q.Documents(ctx)
defer iter.Stop()

_, err := iter.Next()
if err != iterator.Done {
return ErrTokenDuplicate
}

doc := m.client.Collection(m.collectionName).NewDoc()
if err = t.Set(doc, token); err != nil {
return err
}
return nil

}); err != nil {
errCh <- err
return
}
tokenCh <- &token
}()

return tokenCh, errCh
}

// SaveToken saves the given rememberme token to the underlying datastore.
//
// Deprecated: please use the Save method instead
func (m FirebaseTokenManager) SaveToken(ctx context.Context,
token Token) <-chan error {
t, e := m.Add(ctx, token)
errCh := make(chan error)

go func() {
defer close(errCh)

select {
case err := <-e:
errCh <- err

case <-t:
}
}()
return errCh
}

// Validate checks if the given token is valid.
//
// A token is considered valid if it meets the following conditions:
Expand Down Expand Up @@ -413,29 +347,3 @@ func (m FirebaseTokenManager) Validate(ctx context.Context,

return tokenCh, errCh
}

// ValidateToken validates if the given token is stored in the datastore.
//
// If the token is valid, that is the token existed, and it has not been
// revoked, its LastUsed will be updated to the current time to record the
// fact that the token has recently been used, otherwise a ErrTokenInvalid will
// be returned.
//
// Deprecated: please use the Validate method instead
func (m FirebaseTokenManager) ValidateToken(ctx context.Context,
token Token) <-chan error {
errCh := make(chan error)

go func() {
defer close(errCh)
t, e := m.Validate(ctx, token)

select {
case err := <-e:
errCh <- err
case <-t:
}
}()

return errCh
}
Loading