From 0a1b8f9457551680af98e5936a507526ead745a8 Mon Sep 17 00:00:00 2001 From: Donovan Date: Sat, 25 Jan 2025 14:30:06 -0600 Subject: [PATCH] refactor var names --- api/nkode_api.go | 64 ++++++++++++++++++++++---------------------- sqlc/sqlite_queue.go | 6 ++--- 2 files changed, 35 insertions(+), 35 deletions(-) diff --git a/api/nkode_api.go b/api/nkode_api.go index 655557c..e9d3ca8 100644 --- a/api/nkode_api.go +++ b/api/nkode_api.go @@ -20,16 +20,16 @@ const ( ) type NKodeAPI struct { - Db repository.CustomerUserRepository - SignupSessionCache *cache.Cache - EmailQueue *email.Queue + repo repository.CustomerUserRepository + signupSessionCache *cache.Cache + emailQueue *email.Queue } -func NewNKodeAPI(db repository.CustomerUserRepository, queue *email.Queue) NKodeAPI { +func NewNKodeAPI(repo repository.CustomerUserRepository, queue *email.Queue) NKodeAPI { return NKodeAPI{ - Db: db, - EmailQueue: queue, - SignupSessionCache: cache.New(sessionExpiration, sessionCleanupInterval), + repo: repo, + emailQueue: queue, + signupSessionCache: cache.New(sessionExpiration, sessionCleanupInterval), } } @@ -41,7 +41,7 @@ func (n *NKodeAPI) CreateNewCustomer(nkodePolicy entities.NKodePolicy, id *entit if err != nil { return nil, err } - err = n.Db.CreateCustomer(*newCustomer) + err = n.repo.CreateCustomer(*newCustomer) if err != nil { return nil, err @@ -50,7 +50,7 @@ func (n *NKodeAPI) CreateNewCustomer(nkodePolicy entities.NKodePolicy, id *entit } func (n *NKodeAPI) GenerateSignupResetInterface(userEmail entities.UserEmail, customerId entities.CustomerId, kp entities.KeypadDimension, reset bool) (*entities.SignupResetInterface, error) { - user, err := n.Db.GetUser(userEmail, customerId) + user, err := n.repo.GetUser(userEmail, customerId) if err != nil { return nil, err } @@ -58,7 +58,7 @@ func (n *NKodeAPI) GenerateSignupResetInterface(userEmail entities.UserEmail, cu log.Printf("user %s already exists", string(userEmail)) return nil, config.ErrUserAlreadyExists } - svgIdxInterface, err := n.Db.RandomSvgIdxInterface(kp) + svgIdxInterface, err := n.repo.RandomSvgIdxInterface(kp) if err != nil { return nil, err } @@ -66,10 +66,10 @@ func (n *NKodeAPI) GenerateSignupResetInterface(userEmail entities.UserEmail, cu if err != nil { return nil, err } - if err := n.SignupSessionCache.Add(signupSession.Id.String(), *signupSession, sessionExpiration); err != nil { + if err := n.signupSessionCache.Add(signupSession.Id.String(), *signupSession, sessionExpiration); err != nil { return nil, err } - svgInterface, err := n.Db.GetSvgStringInterface(signupSession.LoginUserInterface.SvgId) + svgInterface, err := n.repo.GetSvgStringInterface(signupSession.LoginUserInterface.SvgId) if err != nil { return nil, err @@ -84,12 +84,12 @@ func (n *NKodeAPI) GenerateSignupResetInterface(userEmail entities.UserEmail, cu } func (n *NKodeAPI) SetNKode(customerId entities.CustomerId, sessionId entities.SessionId, keySelection entities.KeySelection) (entities.IdxInterface, error) { - _, err := n.Db.GetCustomer(customerId) + _, err := n.repo.GetCustomer(customerId) if err != nil { return nil, err } - session, exists := n.SignupSessionCache.Get(sessionId.String()) + session, exists := n.signupSessionCache.Get(sessionId.String()) if !exists { log.Printf("session id does not exist %s", sessionId) return nil, config.ErrSignupSessionDNE @@ -103,12 +103,12 @@ func (n *NKodeAPI) SetNKode(customerId entities.CustomerId, sessionId entities.S if err != nil { return nil, err } - n.SignupSessionCache.Set(sessionId.String(), userSession, sessionExpiration) + n.signupSessionCache.Set(sessionId.String(), userSession, sessionExpiration) return confirmInterface, nil } func (n *NKodeAPI) ConfirmNKode(customerId entities.CustomerId, sessionId entities.SessionId, keySelection entities.KeySelection) error { - session, exists := n.SignupSessionCache.Get(sessionId.String()) + session, exists := n.signupSessionCache.Get(sessionId.String()) if !exists { log.Printf("session id does not exist %s", sessionId) return config.ErrSignupSessionDNE @@ -118,7 +118,7 @@ func (n *NKodeAPI) ConfirmNKode(customerId entities.CustomerId, sessionId entiti // handle the case where the type assertion fails return config.ErrSignupSessionDNE } - customer, err := n.Db.GetCustomer(customerId) + customer, err := n.repo.GetCustomer(customerId) if err != nil { return err } @@ -134,16 +134,16 @@ func (n *NKodeAPI) ConfirmNKode(customerId entities.CustomerId, sessionId entiti return err } if userSession.Reset { - err = n.Db.UpdateUserNKode(*user) + err = n.repo.UpdateUserNKode(*user) } else { - err = n.Db.WriteNewUser(*user) + err = n.repo.WriteNewUser(*user) } - n.SignupSessionCache.Delete(userSession.Id.String()) + n.signupSessionCache.Delete(userSession.Id.String()) return err } func (n *NKodeAPI) GetLoginInterface(userEmail entities.UserEmail, customerId entities.CustomerId) (*entities.LoginInterface, error) { - user, err := n.Db.GetUser(userEmail, customerId) + user, err := n.repo.GetUser(userEmail, customerId) if err != nil { return nil, err } @@ -151,7 +151,7 @@ func (n *NKodeAPI) GetLoginInterface(userEmail entities.UserEmail, customerId en log.Printf("user %s for customer %s dne", userEmail, customerId) return nil, config.ErrUserForCustomerDNE } - svgInterface, err := n.Db.GetSvgStringInterface(user.Interface.SvgId) + svgInterface, err := n.repo.GetSvgStringInterface(user.Interface.SvgId) if err != nil { return nil, err } @@ -166,11 +166,11 @@ func (n *NKodeAPI) GetLoginInterface(userEmail entities.UserEmail, customerId en } func (n *NKodeAPI) Login(customerId entities.CustomerId, userEmail entities.UserEmail, keySelection entities.KeySelection) (*security.AuthenticationTokens, error) { - customer, err := n.Db.GetCustomer(customerId) + customer, err := n.repo.GetCustomer(customerId) if err != nil { return nil, err } - user, err := n.Db.GetUser(userEmail, customerId) + user, err := n.repo.GetUser(userEmail, customerId) if err != nil { return nil, err } @@ -184,7 +184,7 @@ func (n *NKodeAPI) Login(customerId entities.CustomerId, userEmail entities.User } if user.Renew { - err = n.Db.RefreshUserPasscode(*user, passcode, customer.Attributes) + err = n.repo.RefreshUserPasscode(*user, passcode, customer.Attributes) if err != nil { return nil, err } @@ -194,28 +194,28 @@ func (n *NKodeAPI) Login(customerId entities.CustomerId, userEmail entities.User if err != nil { return nil, err } - if err = n.Db.UpdateUserRefreshToken(user.Id, jwtToken.RefreshToken); err != nil { + if err = n.repo.UpdateUserRefreshToken(user.Id, jwtToken.RefreshToken); err != nil { return nil, err } if err = user.Interface.LoginShuffle(); err != nil { return nil, err } - if err = n.Db.UpdateUserInterface(user.Id, user.Interface); err != nil { + if err = n.repo.UpdateUserInterface(user.Id, user.Interface); err != nil { return nil, err } return &jwtToken, nil } func (n *NKodeAPI) RenewAttributes(customerId entities.CustomerId) error { - return n.Db.Renew(customerId) + return n.repo.Renew(customerId) } func (n *NKodeAPI) RandomSvgInterface() ([]string, error) { - return n.Db.RandomSvgInterface(entities.KeypadMax) + return n.repo.RandomSvgInterface(entities.KeypadMax) } func (n *NKodeAPI) RefreshToken(userEmail entities.UserEmail, customerId entities.CustomerId, refreshToken string) (string, error) { - user, err := n.Db.GetUser(userEmail, customerId) + user, err := n.repo.GetUser(userEmail, customerId) if err != nil { return "", err } @@ -238,7 +238,7 @@ func (n *NKodeAPI) RefreshToken(userEmail entities.UserEmail, customerId entitie } func (n *NKodeAPI) ResetNKode(userEmail entities.UserEmail, customerId entities.CustomerId) error { - user, err := n.Db.GetUser(userEmail, customerId) + user, err := n.repo.GetUser(userEmail, customerId) if err != nil { return fmt.Errorf("error getting user in rest nkode %v", err) } @@ -262,6 +262,6 @@ func (n *NKodeAPI) ResetNKode(userEmail entities.UserEmail, customerId entities. Subject: "nKode Reset", Content: htmlBody, } - n.EmailQueue.AddEmail(email) + n.emailQueue.AddEmail(email) return nil } diff --git a/sqlc/sqlite_queue.go b/sqlc/sqlite_queue.go index 20c17e6..5c83f9b 100644 --- a/sqlc/sqlite_queue.go +++ b/sqlc/sqlite_queue.go @@ -10,11 +10,11 @@ import ( const writeBufferSize = 100 -type SqlcGeneric func(*Queries, context.Context, any) error +type GenericQuery func(*Queries, context.Context, any) error type WriteTx struct { ErrChan chan error - Query SqlcGeneric + Query GenericQuery Args interface{} } @@ -63,7 +63,7 @@ func (d *Queue) Stop() error { return d.Db.Close() } -func (d *Queue) EnqueueWriteTx(queryFunc SqlcGeneric, args any) error { +func (d *Queue) EnqueueWriteTx(queryFunc GenericQuery, args any) error { select { case <-d.ctx.Done(): return errors.New("database is shutting down")