git.iko.soy/typeable/oauth2-proxy
on master help sign in
Remove GetPreferredUsername method from Provider interface

It isn't used in any providers and we have future plans to remove the specialness of PreferredUsername and make it an optional field in the session. User, Email & Groups will eventually be the only first class fields on the session that are always set.

commit3371284a3698378147eff32e073b350218b586da authorNick Meves <nick.meves@greenhouse.io> dateWed 23 Sep 2020, 15:55 (6 years ago) parent160685a
3 files changed−13
compare with master
unifiedsplit
oauthproxy.go−7 providers/provider_default.go−5 providers/providers.go−1
oauthproxy.go−7
@@ -310,13 +310,6 @@ func (p *OAuthProxy) redeemCode(ctx context.Context, host, code string) (s *sess
310310 s.Email, err = p.provider.GetEmailAddress(ctx, s)
311311 }
312312
313− if s.PreferredUsername == "" {
314− s.PreferredUsername, err = p.provider.GetPreferredUsername(ctx, s)
315− if err != nil && err.Error() == "not implemented" {
316− err = nil
317− }
318− }
319−
320313 if s.User == "" {
321314 s.User, err = p.provider.GetUserName(ctx, s)
322315 if err != nil && err.Error() == "not implemented" {
providers/provider_default.go−5
@@ -104,11 +104,6 @@ func (p *ProviderData) GetUserName(ctx context.Context, s *sessions.SessionState
104104 return "", errors.New("not implemented")
105105}
106106
107−// GetPreferredUsername returns the Account preferred username
108−func (p *ProviderData) GetPreferredUsername(ctx context.Context, s *sessions.SessionState) (string, error) {
109− return "", errors.New("not implemented")
110−}
111−
112107// ValidateGroup validates that the provided email exists in the configured provider
113108// email group(s).
114109func (p *ProviderData) ValidateGroup(email string) bool {
providers/providers.go−1
@@ -12,7 +12,6 @@ type Provider interface {
1212 Data() *ProviderData
1313 GetEmailAddress(ctx context.Context, s *sessions.SessionState) (string, error)
1414 GetUserName(ctx context.Context, s *sessions.SessionState) (string, error)
15− GetPreferredUsername(ctx context.Context, s *sessions.SessionState) (string, error)
1615 Redeem(ctx context.Context, redirectURI, code string) (*sessions.SessionState, error)
1716 ValidateGroup(string) bool
1817 ValidateSessionState(ctx context.Context, s *sessions.SessionState) bool