Skip to content

chore: introduce typed context keys #2677

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
xlgmokha wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: introduce typed context keys #2677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions internal/api/apitask/apitask.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

"github.com/sirupsen/logrus"
"github.com/supabase/auth/internal/api/apierrors"
"github.com/supabase/auth/internal/ctxkey"
"github.com/supabase/auth/internal/observability"
)

Expand Down Expand Up @@ -81,13 +82,13 @@ func With(ctx context.Context) context.Context {
if !ok {
wrk = &requestWorker{}
}
return context.WithValue(ctx, ctxKey, wrk)
return ctxKey.WithValue(ctx, wrk)
}

var ctxKey = new(int)
var ctxKey = ctxkey.New[*requestWorker]("apitask_worker")

func from(ctx context.Context) (*requestWorker, bool) {
if st, ok := ctx.Value(ctxKey).(*requestWorker); ok && st != nil {
if st, ok := ctxKey.Lookup(ctx); ok && st != nil {
return st, true
}
return nil, false
Expand Down
169 changes: 49 additions & 120 deletions internal/api/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,49 +7,38 @@ import (
"github.com/gofrs/uuid"
jwt "github.com/golang-jwt/jwt/v5"
"github.com/supabase/auth/internal/api/shared"
"github.com/supabase/auth/internal/ctxkey"
"github.com/supabase/auth/internal/models"
)

type contextKey string

func (c contextKey) String() string {
return "gotrue api context key " + string(c)
}

const (
externalProviderTypeKey = contextKey("external_provider_type")
externalProviderEmailOptionalKey = contextKey("external_provider_allow_no_email")

tokenKey = contextKey("jwt")
inviteTokenKey = contextKey("invite_token")
signatureKey = contextKey("signature")
targetUserKey = contextKey("target_user")
factorKey = contextKey("factor")
sessionKey = contextKey("session")
externalReferrerKey = contextKey("external_referrer")
functionHooksKey = contextKey("function_hooks")
adminUserKey = contextKey("admin_user")
oauthTokenKey = contextKey("oauth_token") // for OAuth1.0, also known as request token
oauthVerifierKey = contextKey("oauth_verifier")
ssoProviderKey = contextKey("sso_provider")
externalHostKey = contextKey("external_host")
oauthClientStateKey = contextKey("oauth_client_state_id")
flowStateContextKey = contextKey("flow_state")
var (
externalProviderTypeKey = ctxkey.New[string]("external_provider_type")
externalProviderEmailOptionalKey = ctxkey.New[bool]("external_provider_allow_no_email")

tokenKey = ctxkey.New[*jwt.Token]("jwt")
inviteTokenKey = ctxkey.New[string]("invite_token")
signatureKey = ctxkey.New[string]("signature")
targetUserKey = ctxkey.New[*models.User]("target_user")
factorKey = ctxkey.New[*models.Factor]("factor")
sessionKey = ctxkey.New[*models.Session]("session")
externalReferrerKey = ctxkey.New[string]("external_referrer")
adminUserKey = ctxkey.New[*models.User]("admin_user")
oauthTokenKey = ctxkey.New[string]("oauth_token") // for OAuth1.0, also known as request token
oauthVerifierKey = ctxkey.New[string]("oauth_verifier")
ssoProviderKey = ctxkey.New[*models.SSOProvider]("sso_provider")
externalHostKey = ctxkey.New[*url.URL]("external_host")
oauthClientStateKey = ctxkey.New[uuid.UUID]("oauth_client_state_id")
flowStateContextKey = ctxkey.New[*models.FlowState]("flow_state")
)

// withToken adds the JWT token to the context.
func withToken(ctx context.Context, token *jwt.Token) context.Context {
return context.WithValue(ctx, tokenKey, token)
return tokenKey.WithValue(ctx, token)
}

// getToken reads the JWT token from the context.
func getToken(ctx context.Context) *jwt.Token {
obj := ctx.Value(tokenKey)
if obj == nil {
return nil
}

return obj.(*jwt.Token)
return tokenKey.Value(ctx)
}

func getClaims(ctx context.Context) *AccessTokenClaims {
Expand All @@ -67,12 +56,12 @@ func withUser(ctx context.Context, u *models.User) context.Context {

// withTargetUser adds the target user for linking to the context.
func withTargetUser(ctx context.Context, u *models.User) context.Context {
return context.WithValue(ctx, targetUserKey, u)
return targetUserKey.WithValue(ctx, u)
}

// with Factor adds the factor id to the context.
func withFactor(ctx context.Context, f *models.Factor) context.Context {
return context.WithValue(ctx, factorKey, f)
return factorKey.WithValue(ctx, f)
}

// getUser reads the user from the context.
Expand All @@ -82,103 +71,68 @@ func getUser(ctx context.Context) *models.User {

// getTargetUser reads the user from the context.
func getTargetUser(ctx context.Context) *models.User {
if ctx == nil {
return nil
}
obj := ctx.Value(targetUserKey)
if obj == nil {
return nil
}
return obj.(*models.User)
return targetUserKey.Value(ctx)
}

// getFactor reads the factor id from the context
func getFactor(ctx context.Context) *models.Factor {
obj := ctx.Value(factorKey)
if obj == nil {
return nil
}
return obj.(*models.Factor)
return factorKey.Value(ctx)
}

// withSession adds the session to the context.
func withSession(ctx context.Context, s *models.Session) context.Context {
return context.WithValue(ctx, sessionKey, s)
return sessionKey.WithValue(ctx, s)
}

// getSession reads the session from the context.
func getSession(ctx context.Context) *models.Session {
if ctx == nil {
return nil
}
obj := ctx.Value(sessionKey)
if obj == nil {
return nil
}
return obj.(*models.Session)
return sessionKey.Value(ctx)
}

// withSignature adds the provided request ID to the context.
func withSignature(ctx context.Context, id string) context.Context {
return context.WithValue(ctx, signatureKey, id)
return signatureKey.WithValue(ctx, id)
}

func withInviteToken(ctx context.Context, token string) context.Context {
return context.WithValue(ctx, inviteTokenKey, token)
return inviteTokenKey.WithValue(ctx, token)
}

func withOAuthClientStateID(ctx context.Context, oauthClientStateID uuid.UUID) context.Context {
return context.WithValue(ctx, oauthClientStateKey, oauthClientStateID)
return oauthClientStateKey.WithValue(ctx, oauthClientStateID)
}

func getOAuthClientStateID(ctx context.Context) uuid.UUID {
obj := ctx.Value(oauthClientStateKey)
if obj == nil {
return uuid.Nil
}

return obj.(uuid.UUID)
return oauthClientStateKey.Value(ctx)
}

// withFlowState stores the entire FlowState object in the context
func withFlowState(ctx context.Context, flowState *models.FlowState) context.Context {
return context.WithValue(ctx, flowStateContextKey, flowState)
return flowStateContextKey.WithValue(ctx, flowState)
}

// getFlowState retrieves the FlowState object from the context
func getFlowState(ctx context.Context) *models.FlowState {
obj := ctx.Value(flowStateContextKey)
if obj == nil {
return nil
}
return obj.(*models.FlowState)
return flowStateContextKey.Value(ctx)
}

func getInviteToken(ctx context.Context) string {
obj := ctx.Value(inviteTokenKey)
if obj == nil {
return ""
}

return obj.(string)
return inviteTokenKey.Value(ctx)
}

// withExternalProviderType adds the provided request ID to the context.
func withExternalProviderType(ctx context.Context, id string, emailOptional bool) context.Context {
return context.WithValue(context.WithValue(ctx, externalProviderTypeKey, id), externalProviderEmailOptionalKey, emailOptional)
return externalProviderEmailOptionalKey.WithValue(externalProviderTypeKey.WithValue(ctx, id), emailOptional)
}

// getExternalProviderType returns the provider type and whether user data without email address should be allowed.
func getExternalProviderType(ctx context.Context) (string, bool) {
idValue := ctx.Value(externalProviderTypeKey)
emailOptionalValue := ctx.Value(externalProviderEmailOptionalKey)

id, okID := idValue.(string)
id, okID := externalProviderTypeKey.Lookup(ctx)
if !okID {
return "", false
}

emailOptional, okEmailOptional := emailOptionalValue.(bool)
emailOptional, okEmailOptional := externalProviderEmailOptionalKey.Lookup(ctx)
if !okEmailOptional {
return "", false
}
Expand All @@ -187,77 +141,52 @@ func getExternalProviderType(ctx context.Context) (string, bool) {
}

func withExternalReferrer(ctx context.Context, token string) context.Context {
return context.WithValue(ctx, externalReferrerKey, token)
return externalReferrerKey.WithValue(ctx, token)
}

func getExternalReferrer(ctx context.Context) string {
obj := ctx.Value(externalReferrerKey)
if obj == nil {
return ""
}

return obj.(string)
return externalReferrerKey.Value(ctx)
}

// withAdminUser adds the admin user to the context.
func withAdminUser(ctx context.Context, u *models.User) context.Context {
return context.WithValue(ctx, adminUserKey, u)
return adminUserKey.WithValue(ctx, u)
}

// getAdminUser reads the admin user from the context.
func getAdminUser(ctx context.Context) *models.User {
obj := ctx.Value(adminUserKey)
if obj == nil {
return nil
}
return obj.(*models.User)
return adminUserKey.Value(ctx)
}

// withRequestToken adds the request token to the context
func withRequestToken(ctx context.Context, token string) context.Context {
return context.WithValue(ctx, oauthTokenKey, token)
return oauthTokenKey.WithValue(ctx, token)
}

func getRequestToken(ctx context.Context) string {
obj := ctx.Value(oauthTokenKey)
if obj == nil {
return ""
}
return obj.(string)
return oauthTokenKey.Value(ctx)
}

func withOAuthVerifier(ctx context.Context, token string) context.Context {
return context.WithValue(ctx, oauthVerifierKey, token)
return oauthVerifierKey.WithValue(ctx, token)
}

func getOAuthVerifier(ctx context.Context) string {
obj := ctx.Value(oauthVerifierKey)
if obj == nil {
return ""
}
return obj.(string)
return oauthVerifierKey.Value(ctx)
}

func withSSOProvider(ctx context.Context, provider *models.SSOProvider) context.Context {
return context.WithValue(ctx, ssoProviderKey, provider)
return ssoProviderKey.WithValue(ctx, provider)
}

func getSSOProvider(ctx context.Context) *models.SSOProvider {
obj := ctx.Value(ssoProviderKey)
if obj == nil {
return nil
}
return obj.(*models.SSOProvider)
return ssoProviderKey.Value(ctx)
}

func withExternalHost(ctx context.Context, u *url.URL) context.Context {
return context.WithValue(ctx, externalHostKey, u)
return externalHostKey.WithValue(ctx, u)
}

func getExternalHost(ctx context.Context) *url.URL {
obj := ctx.Value(externalHostKey)
if obj == nil {
return nil
}
return obj.(*url.URL)
return externalHostKey.Value(ctx)
}
Loading
Loading