Skip to content

fix(fly): return user with correct auth #56523

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.

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

Merged
merged 2 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
23 changes: 20 additions & 3 deletions src/sentry/services/hybrid_cloud/user/impl.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
OrganizationStatus,
UserEmail,
)
from sentry.models.authidentity import AuthIdentity
from sentry.models.user import User
from sentry.services.hybrid_cloud.auth import AuthenticationContext
from sentry.services.hybrid_cloud.filter_query import (
Expand All @@ -37,6 +38,7 @@
)
from sentry.services.hybrid_cloud.user.serial import serialize_rpc_user
from sentry.services.hybrid_cloud.user.service import UserService
from sentry.signals import user_signup

logger = logging.getLogger("user:provisioning")

Expand Down Expand Up @@ -172,7 +174,9 @@ def get_first_superuser(self) -> Optional[RpcUser]:
return None
return serialize_rpc_user(user)

def get_or_create_user_by_email(self, *, email: str) -> RpcUser:
def get_or_create_user_by_email(
Copy link
Member

Choose a reason for hiding this comment

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

@sentaur-athena Since get_or_create_user_by_email() is called in getsentry, and the function signature has changed, it might be better to use a new function name (e.g. get_or_create_user_by_email2) so that it's easier to make the switch on getsentry.

Otherwise, the get_or_create_user_by_email() call will error out on getsentry.

Copy link
Member Author

@sentaur-athena sentaur-athena Sep 20, 2023

Choose a reason for hiding this comment

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

Interesting. @dashed would it still error although I defined the new parameters as optional? It doesn't error locally without changes in getsentry

Copy link
Member

Choose a reason for hiding this comment

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

@sentaur-athena I think it'll be fine if the new arguments are optional.

self, *, email: str, ident: Optional[str] = None, referrer: Optional[str] = None
) -> RpcUser:
with transaction.atomic(router.db_for_write(User)):
user_query = User.objects.filter(email__iexact=email, is_active=True)
# Create User if it doesn't exist
Expand All @@ -182,12 +186,25 @@ def get_or_create_user_by_email(self, *, email: str) -> RpcUser:
email=email,
name=email,
)
user_signup.send_robust(
sender=self, user=user, source="api", referrer=referrer or "unknown"
)
else:
# Users are not supposed to have the same email but right now our auth pipeline let this happen
# So let's not break the user experience
# So let's not break the user experience. Instead return the user with auth identity of ident or
# the first user if ident is None
user = user_query[0]
if user_query.count() > 1:
logger.warning("Email has multiple users", extra={"email": email})
user = user_query[0]
if ident:
for candid_user in user_query:
identity_query = AuthIdentity.objects.filter(
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

@dashed I'm aware of that. The problem I'm facing is for the people who have been in this flow before and already have auth_identity created for them. For example:

  1. Athena has 2 users, Athena1 and Athena2
  2. She provisions a new org and in that process we create Athena1 an auth identity related to that org
  3. Later she provisions a project get_or_create_new_user() returns Athena2 so then auth_service.create_auth_identity() tries to create auth_identity because Athena2 doesn't have one. That would throw an error because Athena1 is using the same ident.

In this fix I want to make sure that if a user already has an ident return that one from get_or_create_new_user() otherwise it doesn't matter.

Copy link
Member

Choose a reason for hiding this comment

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

@sentaur-athena that makes sense. The case you outlined might be good to add to https://github.com/getsentry/getsentry/blob/master/tests/getsentry/web/channel_provisioning/test_process.py in case you haven't done so. 👍

user=candid_user, ident=ident
)
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like an N+1 query? Probably want to do something like

AuthIdentity.objects.filter(user__in=user_query, ident=ident)

and then loop over the result.

It might also be worth logging if that query returns multiple AuthIdentity objects.

if identity_query.exists():
user = candid_user
break

return serialize_rpc_user(user)

def verify_any_email(self, *, email: str) -> bool:
Expand Down
4 changes: 3 additions & 1 deletion src/sentry/services/hybrid_cloud/user/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,9 @@ def get_first_superuser(self) -> Optional[RpcUser]:

@rpc_method
@abstractmethod
def get_or_create_user_by_email(self, *, email: str) -> RpcUser:
def get_or_create_user_by_email(
self, *, email: str, ident: Optional[str] = None, referrer: Optional[str] = None
) -> RpcUser:
pass

@rpc_method
Expand Down
19 changes: 19 additions & 0 deletions tests/sentry/services/hybrid_cloud/user/test_impl.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
from sentry.auth.providers.fly.provider import FlyOAuth2Provider
from sentry.models.authidentity import AuthIdentity
from sentry.models.authprovider import AuthProvider
from sentry.services.hybrid_cloud.user.service import user_service
from sentry.testutils.cases import TestCase
from sentry.testutils.silo import control_silo_test
Expand Down Expand Up @@ -28,3 +31,19 @@ def test_get_user_ci(self):
user = self.create_user(email="[email protected]")
fetched_user = user_service.get_or_create_user_by_email(email="[email protected]")
assert user.id == fetched_user.id

def test_get_user_with_ident(self):
user1 = self.create_user(email="[email protected]", username="1")
user2 = self.create_user(email="[email protected]", username="2")
org = self.create_organization(slug="test")
config_data = FlyOAuth2Provider.build_config(resource={"id": "x1234x"})
partner_user_id = "u4567u"
provider = AuthProvider.objects.create(
organization_id=org.id, provider="fly", config=config_data
)
AuthIdentity.objects.create(auth_provider=provider, user=user2, ident=partner_user_id)
fetched_user = user_service.get_or_create_user_by_email(
email="[email protected]", ident=partner_user_id
)
assert user2.id == fetched_user.id
assert user1.id != fetched_user.id