Skip to content

Add username to get account #265

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

Open
ahme-dev wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add username to get account #265

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4f2e0bb
feat: add username param to AccountGetter
ahme-dev Jan 27, 2025
b02a711
feat: use username param in get account
ahme-dev Jan 27, 2025
457bd6f
fix: account route for username
ahme-dev Jan 27, 2025
927c32d
test: add test for get account route
ahme-dev Jan 27, 2025
354c647
test: remove encoding for @ in test file
ahme-dev Jan 27, 2025
14d9b99
fix: re-add not found error
ahme-dev Feb 5, 2025
f610612
test: fix usage of same account in subsequent test
ahme-dev Feb 8, 2025
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
31 changes: 26 additions & 5 deletions app/services/account_getter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,37 @@ import (
"github.com/pkg/errors"
)

func AccountGetter(store data.AccountStore, accountID int) (*models.Account, error) {
account, err := store.Find(accountID)
if err != nil {
return nil, errors.Wrap(err, "Find")
type AccountGetterParams struct {
AccountID *int
Username *string
}

func AccountGetter(store data.AccountStore, params AccountGetterParams) (*models.Account, error) {
Comment on lines +9 to +14

@ahme-dev ahme-dev Jan 27, 2025

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't seen structs used for params, so let me know if this should be changed

var account *models.Account

if params.AccountID != nil {
ac, err := store.Find(*params.AccountID)
if err != nil {
return nil, errors.Wrap(err, "Find")
}

account = ac
}

if params.Username != nil && params.AccountID == nil {
ac, err := store.FindByUsername(*params.Username)
if err != nil {
return nil, errors.Wrap(err, "FindByUsername")
}

account = ac
}

if account == nil {
return nil, FieldErrors{{"account", ErrNotFound}}
}

oauthAccounts, err := store.GetOauthAccounts(accountID)
oauthAccounts, err := store.GetOauthAccounts(account.ID)
if err != nil {
return nil, errors.Wrap(err, "GetOauthAccounts")
}
Expand Down
34 changes: 31 additions & 3 deletions app/services/account_getter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,29 @@ import (

func TestAccountGetter(t *testing.T) {

t.Run("get username", func(t *testing.T) {
accountStore := mock.NewAccountStore()
acc, err := accountStore.Create("user@keratin.tech", []byte("password"))
require.NoError(t, err)

accountID := acc.ID

account, err := services.AccountGetter(accountStore, services.AccountGetterParams{
Username: &acc.Username,
})
require.NoError(t, err)

require.Equal(t, accountID, account.ID)
})

t.Run("get non existing account", func(t *testing.T) {
accountStore := mock.NewAccountStore()
account, err := services.AccountGetter(accountStore, 9999)

accountID := 9999

account, err := services.AccountGetter(accountStore, services.AccountGetterParams{
AccountID: &accountID,
})

require.NotNil(t, err)
require.Nil(t, account)
Expand All @@ -24,7 +44,11 @@ func TestAccountGetter(t *testing.T) {
acc, err := accountStore.Create("user@keratin.tech", []byte("password"))
require.NoError(t, err)

account, err := services.AccountGetter(accountStore, acc.ID)
accountID := acc.ID

account, err := services.AccountGetter(accountStore, services.AccountGetterParams{
AccountID: &accountID,
})
require.NoError(t, err)

require.Equal(t, 0, len(account.OauthAccounts))
Expand All @@ -41,7 +65,11 @@ func TestAccountGetter(t *testing.T) {
err = accountStore.AddOauthAccount(acc.ID, "trial", "ID2", "email2", "TOKEN2")
require.NoError(t, err)

account, err := services.AccountGetter(accountStore, acc.ID)
accountID := acc.ID

account, err := services.AccountGetter(accountStore, services.AccountGetterParams{
AccountID: &accountID,
})
require.NoError(t, err)

oAccounts := account.OauthAccounts
Expand Down
4 changes: 3 additions & 1 deletion app/services/totp_creator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ var ErrExistingTOTPSecret = errors.New("a OTP secret has already been establishe

// TOTPCreator handles the creation and storage of new OTP tokens
func TOTPCreator(accountStore data.AccountStore, totpCache data.TOTPCache, accountID int, audience *route.Domain) (*otp.Key, error) {
account, err := AccountGetter(accountStore, accountID)
account, err := AccountGetter(accountStore, AccountGetterParams{
AccountID: &accountID,
})
if err != nil {
return nil, err
}
Expand Down
4 changes: 3 additions & 1 deletion app/services/totp_setter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ func TOTPSetter(accountStore data.AccountStore, totpCache data.TOTPCache, cfg *a
return FieldErrors{{"otp", ErrInvalidOrExpired}}
}

account, err := AccountGetter(accountStore, accountID)
account, err := AccountGetter(accountStore, AccountGetterParams{
AccountID: &accountID,
})
if err != nil {
return err
}
Expand Down
20 changes: 16 additions & 4 deletions server/handlers/get_account.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,25 @@ import (

func GetAccount(app *app.App) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
id, err := strconv.Atoi(mux.Vars(r)["id"])
if err != nil {
WriteNotFound(w, "account")
var paramID *int
var paramUsername *string

idOrUsername := mux.Vars(r)["id"]
if idOrUsername == "" {
return
}

account, err := services.AccountGetter(app.AccountStore, id)
id, err := strconv.Atoi(idOrUsername)
if err != nil {
paramUsername = &idOrUsername
} else {
paramID = &id
}

account, err := services.AccountGetter(app.AccountStore, services.AccountGetterParams{
AccountID: paramID,
Username: paramUsername,
})
if err != nil {
if _, ok := err.(services.FieldErrors); ok {
WriteNotFound(w, "account")
Comment thread
cainlevy marked this conversation as resolved.
Expand Down
20 changes: 20 additions & 0 deletions server/handlers/get_account_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,26 @@ func TestGetAccount(t *testing.T) {

assertGetAccountResponse(t, res, account, oauthAccounts)
})

t.Run("valid account username", func(t *testing.T) {
account, err := app.AccountStore.Create("unlocked@test.com", []byte("bar"))
require.NoError(t, err)

err = app.AccountStore.AddOauthAccount(account.ID, "test", "ID1", "email", "TOKEN1")
require.NoError(t, err)

err = app.AccountStore.AddOauthAccount(account.ID, "trial", "ID2", "email", "TOKEN2")
require.NoError(t, err)

oauthAccounts, err := app.AccountStore.GetOauthAccounts(account.ID)
require.NoError(t, err)

res, err := client.Get(fmt.Sprintf("/accounts/%v", account.Username))
require.NoError(t, err)
assert.Equal(t, http.StatusOK, res.StatusCode)

assertGetAccountResponse(t, res, account, oauthAccounts)
})
}

func assertGetAccountResponse(t *testing.T, res *http.Response, acc *models.Account, oAccs []*models.OauthAccount) {
Expand Down
4 changes: 3 additions & 1 deletion server/handlers/get_oauth_accounts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ func GetOauthAccounts(app *app.App) http.HandlerFunc {
return
}

account, err := services.AccountGetter(app.AccountStore, accountID)
account, err := services.AccountGetter(app.AccountStore, services.AccountGetterParams{
AccountID: &accountID,
})
if err != nil {
WriteErrors(w, err)
return
Expand Down
2 changes: 1 addition & 1 deletion server/private_routes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func PrivateRoutes(app *app.App) []*route.HandledRoute {
SecuredWith(authentication).
Handle(handlers.PostAccountsImport(app)),

route.Get("/accounts/{id:[0-9]+}").
route.Get("/accounts/{id}").

@ahme-dev ahme-dev Feb 8, 2025

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cainlevy, one of the tests (for available account) fails because this overrides the public route "/accounts/available". Any suggestions to work around this? Can't use the older [0-9] since it rejects accept emails. I think we ideally want to put the overriden route above this route definition, but being in separate files, it might be difficult.

@cainlevy cainlevy Feb 18, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes that is awkward.

I think it's worth trying to register public routes before private routes to fix this. It sounds like the test case, as written, will ensure it remains that way. If we later run into a new issue that implies a need to reverse the order again, we'll find a new kind of solution.

SecuredWith(authentication).
Handle(handlers.GetAccount(app)),

Expand Down