Skip to content

fix(relocation): Clean up relocation serializer #71930

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

Merged
merged 1 commit into from
Jun 4, 2024
Merged

fix(relocation): Clean up relocation serializer #71930

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
39 changes: 33 additions & 6 deletions src/sentry/api/serializers/models/relocation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
from sentry.services.hybrid_cloud.user.model import RpcUser
from sentry.services.hybrid_cloud.user.service import user_service

NEEDED_USER_FIELDS = {"email", "id", "username"}


@dataclasses.dataclass(frozen=True)
class RelocationMetadata:
Expand Down Expand Up @@ -64,16 +66,41 @@ def serialize(
else None
)

creator_user = attrs.meta_users.get(obj.creator_id, None)
creator = (
None
if creator_user is None
else {
"email": creator_user.email,
"id": str(creator_user.id),
"username": creator_user.username,
}
)
owner_user = attrs.meta_users.get(obj.owner_id, None)
owner = (
None
if owner_user is None
else {
"email": owner_user.email,
"id": str(owner_user.id),
"username": owner_user.username,
}
)

return {
"dateAdded": obj.date_added,
"dateUpdated": obj.date_updated,
"uuid": str(obj.uuid),
"creatorEmail": attrs.meta_users[obj.creator_id].email,
"creatorId": str(obj.creator_id),
"creatorUsername": attrs.meta_users[obj.creator_id].username,
"ownerEmail": attrs.meta_users[obj.owner_id].email,
"ownerId": str(obj.owner_id),
"ownerUsername": attrs.meta_users[obj.owner_id].username,
"creator": creator,
# TODO(azaslavsky): delete these 3 fields after clients are migrated
"creatorEmail": creator["email"] if creator else None,
"creatorId": creator["id"] if creator else None,
"creatorUsername": creator["username"] if creator else None,
"owner": owner,
# TODO(azaslavsky): delete these 3 fields after clients are migrated
"ownerEmail": owner["email"] if owner else None,
"ownerId": owner["id"] if owner else None,
"ownerUsername": owner["username"] if owner else None,
"status": Relocation.Status(obj.status).name,
"step": Relocation.Step(obj.step).name,
"failureReason": obj.failure_reason,
Expand Down
40 changes: 40 additions & 0 deletions tests/sentry/api/endpoints/relocations/test_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,17 @@ def test_good_status_in_progress(self):

assert len(response.data) == 1
assert response.data[0]["status"] == Relocation.Status.IN_PROGRESS.name
assert response.data[0]["creator"]["id"] == str(self.superuser.id)
assert response.data[0]["creator"]["email"] == str(self.superuser.email)
assert response.data[0]["creator"]["username"] == str(self.superuser.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data[0]["creatorId"] == str(self.superuser.id)
assert response.data[0]["creatorEmail"] == str(self.superuser.email)
assert response.data[0]["creatorUsername"] == str(self.superuser.username)
assert response.data[0]["owner"]["id"] == str(self.owner.id)
assert response.data[0]["owner"]["email"] == str(self.owner.email)
assert response.data[0]["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data[0]["ownerId"] == str(self.owner.id)
assert response.data[0]["ownerEmail"] == str(self.owner.email)
assert response.data[0]["ownerUsername"] == str(self.owner.username)
Expand Down Expand Up @@ -328,9 +336,17 @@ def test_good_simple(
assert response.data["status"] == Relocation.Status.IN_PROGRESS.name
assert response.data["step"] == Relocation.Step.UPLOADING.name
assert response.data["scheduledPauseAtStep"] is None
assert response.data["creator"]["id"] == str(self.owner.id)
assert response.data["creator"]["email"] == str(self.owner.email)
assert response.data["creator"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["creatorId"] == str(self.owner.id)
assert response.data["creatorEmail"] == str(self.owner.email)
assert response.data["creatorUsername"] == str(self.owner.username)
assert response.data["owner"]["id"] == str(self.owner.id)
assert response.data["owner"]["email"] == str(self.owner.email)
assert response.data["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["ownerId"] == str(self.owner.id)
assert response.data["ownerEmail"] == str(self.owner.email)
assert response.data["ownerUsername"] == str(self.owner.username)
Expand Down Expand Up @@ -391,9 +407,17 @@ def test_good_promo_code(
assert response.data["status"] == Relocation.Status.IN_PROGRESS.name
assert response.data["step"] == Relocation.Step.UPLOADING.name
assert response.data["scheduledPauseAtStep"] is None
assert response.data["creator"]["id"] == str(self.owner.id)
assert response.data["creator"]["email"] == str(self.owner.email)
assert response.data["creator"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["creatorId"] == str(self.owner.id)
assert response.data["creatorEmail"] == str(self.owner.email)
assert response.data["creatorUsername"] == str(self.owner.username)
assert response.data["owner"]["id"] == str(self.owner.id)
assert response.data["owner"]["email"] == str(self.owner.email)
assert response.data["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["ownerId"] == str(self.owner.id)
assert response.data["ownerEmail"] == str(self.owner.email)
assert response.data["ownerUsername"] == str(self.owner.username)
Expand Down Expand Up @@ -561,9 +585,17 @@ def test_good_staff_when_feature_disabled(

assert response.data["status"] == Relocation.Status.IN_PROGRESS.name
assert response.data["step"] == Relocation.Step.UPLOADING.name
assert response.data["creator"]["id"] == str(self.staff_user.id)
assert response.data["creator"]["email"] == str(self.staff_user.email)
assert response.data["creator"]["username"] == str(self.staff_user.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["creatorId"] == str(self.staff_user.id)
assert response.data["creatorEmail"] == str(self.staff_user.email)
assert response.data["creatorUsername"] == str(self.staff_user.username)
assert response.data["owner"]["id"] == str(self.owner.id)
assert response.data["owner"]["email"] == str(self.owner.email)
assert response.data["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["ownerId"] == str(self.owner.id)
assert response.data["ownerEmail"] == str(self.owner.email)
assert response.data["ownerUsername"] == str(self.owner.username)
Expand Down Expand Up @@ -622,9 +654,17 @@ def test_good_superuser_when_feature_disabled(

assert response.data["status"] == Relocation.Status.IN_PROGRESS.name
assert response.data["step"] == Relocation.Step.UPLOADING.name
assert response.data["creator"]["id"] == str(self.superuser.id)
assert response.data["creator"]["email"] == str(self.superuser.email)
assert response.data["creator"]["username"] == str(self.superuser.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["creatorId"] == str(self.superuser.id)
assert response.data["creatorEmail"] == str(self.superuser.email)
assert response.data["creatorUsername"] == str(self.superuser.username)
assert response.data["owner"]["id"] == str(self.owner.id)
assert response.data["owner"]["email"] == str(self.owner.email)
assert response.data["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["ownerId"] == str(self.owner.id)
assert response.data["ownerEmail"] == str(self.owner.email)
assert response.data["ownerUsername"] == str(self.owner.username)
Expand Down
24 changes: 24 additions & 0 deletions tests/sentry/api/endpoints/relocations/test_retry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,17 @@ def test_good_simple(self, uploading_complete_mock: Mock, analytics_record_mock:
assert response.data["status"] == Relocation.Status.IN_PROGRESS.name
assert response.data["step"] == Relocation.Step.UPLOADING.name
assert response.data["wantOrgSlugs"] == self.relocation.want_org_slugs
assert response.data["creator"]["id"] == str(self.owner.id)
assert response.data["creator"]["email"] == str(self.owner.email)
assert response.data["creator"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["creatorId"] == str(self.owner.id)
assert response.data["creatorEmail"] == str(self.owner.email)
assert response.data["creatorUsername"] == str(self.owner.username)
assert response.data["owner"]["id"] == str(self.owner.id)
assert response.data["owner"]["email"] == str(self.owner.email)
assert response.data["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["ownerId"] == str(self.owner.id)
assert response.data["ownerEmail"] == str(self.owner.email)
assert response.data["ownerUsername"] == str(self.owner.username)
Expand Down Expand Up @@ -147,9 +155,17 @@ def test_good_staff_when_feature_disabled(
response = self.get_success_response(self.relocation.uuid, status_code=201)

assert response.data["uuid"] != self.relocation.uuid
assert response.data["creator"]["id"] == str(self.staff_user.id)
assert response.data["creator"]["email"] == str(self.staff_user.email)
assert response.data["creator"]["username"] == str(self.staff_user.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["creatorId"] == str(self.staff_user.id)
assert response.data["creatorEmail"] == str(self.staff_user.email)
assert response.data["creatorUsername"] == str(self.staff_user.username)
assert response.data["owner"]["id"] == str(self.owner.id)
assert response.data["owner"]["email"] == str(self.owner.email)
assert response.data["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["ownerId"] == str(self.owner.id)
assert response.data["ownerEmail"] == str(self.owner.email)
assert response.data["ownerUsername"] == str(self.owner.username)
Expand Down Expand Up @@ -185,9 +201,17 @@ def test_good_superuser_when_feature_disabled(
response = self.get_success_response(self.relocation.uuid, status_code=201)

assert response.data["uuid"] != self.relocation.uuid
assert response.data["creator"]["id"] == str(self.superuser.id)
assert response.data["creator"]["email"] == str(self.superuser.email)
assert response.data["creator"]["username"] == str(self.superuser.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["creatorId"] == str(self.superuser.id)
assert response.data["creatorEmail"] == str(self.superuser.email)
assert response.data["creatorUsername"] == str(self.superuser.username)
assert response.data["owner"]["id"] == str(self.owner.id)
assert response.data["owner"]["email"] == str(self.owner.email)
assert response.data["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert response.data["ownerId"] == str(self.owner.id)
assert response.data["ownerEmail"] == str(self.owner.email)
assert response.data["ownerUsername"] == str(self.owner.username)
Expand Down
32 changes: 32 additions & 0 deletions tests/sentry/api/serializers/test_relocation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,17 @@ def test_in_progress(self):
assert result["dateAdded"] == TEST_DATE_ADDED
assert result["dateUpdated"] == TEST_DATE_UPDATED
assert result["uuid"] == str(relocation.uuid)
assert result["creator"]["id"] == str(self.superuser.id)
assert result["creator"]["email"] == str(self.superuser.email)
assert result["creator"]["username"] == str(self.superuser.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["creatorId"] == str(self.superuser.id)
assert result["creatorEmail"] == self.superuser.email
assert result["creatorUsername"] == self.superuser.username
assert result["owner"]["id"] == str(self.owner.id)
assert result["owner"]["email"] == str(self.owner.email)
assert result["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["ownerId"] == str(self.owner.id)
assert result["ownerEmail"] == self.owner.email
assert result["ownerUsername"] == self.owner.username
Expand Down Expand Up @@ -112,9 +120,17 @@ def test_pause(self):
assert result["dateAdded"] == TEST_DATE_ADDED
assert result["dateUpdated"] == TEST_DATE_UPDATED
assert result["uuid"] == str(relocation.uuid)
assert result["creator"]["id"] == str(self.superuser.id)
assert result["creator"]["email"] == str(self.superuser.email)
assert result["creator"]["username"] == str(self.superuser.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["creatorId"] == str(self.superuser.id)
assert result["creatorEmail"] == self.superuser.email
assert result["creatorUsername"] == self.superuser.username
assert result["owner"]["id"] == str(self.owner.id)
assert result["owner"]["email"] == str(self.owner.email)
assert result["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["ownerId"] == str(self.owner.id)
assert result["ownerEmail"] == self.owner.email
assert result["ownerUsername"] == self.owner.username
Expand Down Expand Up @@ -155,9 +171,17 @@ def test_success(self):
assert result["dateAdded"] == TEST_DATE_ADDED
assert result["dateUpdated"] == TEST_DATE_UPDATED
assert result["uuid"] == str(relocation.uuid)
assert result["creator"]["id"] == str(self.superuser.id)
assert result["creator"]["email"] == str(self.superuser.email)
assert result["creator"]["username"] == str(self.superuser.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["creatorId"] == str(self.superuser.id)
assert result["creatorEmail"] == self.superuser.email
assert result["creatorUsername"] == self.superuser.username
assert result["owner"]["id"] == str(self.owner.id)
assert result["owner"]["email"] == str(self.owner.email)
assert result["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["ownerId"] == str(self.owner.id)
assert result["ownerEmail"] == self.owner.email
assert result["ownerUsername"] == self.owner.username
Expand Down Expand Up @@ -198,9 +222,17 @@ def test_failure(self):
assert result["dateAdded"] == TEST_DATE_ADDED
assert result["dateUpdated"] == TEST_DATE_UPDATED
assert result["uuid"] == str(relocation.uuid)
assert result["creator"]["id"] == str(self.superuser.id)
assert result["creator"]["email"] == str(self.superuser.email)
assert result["creator"]["username"] == str(self.superuser.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["creatorId"] == str(self.superuser.id)
assert result["creatorEmail"] == self.superuser.email
assert result["creatorUsername"] == self.superuser.username
assert result["owner"]["id"] == str(self.owner.id)
assert result["owner"]["email"] == str(self.owner.email)
assert result["owner"]["username"] == str(self.owner.username)
# TODO(azaslavsky): delete these after clients are migrated
assert result["ownerId"] == str(self.owner.id)
assert result["ownerEmail"] == self.owner.email
assert result["ownerUsername"] == self.owner.username
Expand Down
Loading