feat(organizations): add owner_label field to AssetSerializer TASK-1181
#5312
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rajpatel24
force-pushed
the
task-1181-add-owner_label-field-to-asset-serializer
branch
from
916e01c
to
aa796c9
Compare
noliveleger
requested changes
Dec 2, 2024
kpi/tests/api/v2/test_api_assets.py
Outdated
| @@ -1,5 +1,6 @@ | |||
| import copy | |||
| import json | |||
| import mock | |||
There was a problem hiding this comment.
This is deprecated, please use from unitest import mock instead
kpi/tests/api/v2/test_api_assets.py
Outdated
Comment on lines
112
to
140
| # Fetch the assets list and verify the initial owner_label | ||
| list_response = self.client.get(self.list_url) | ||
| self.assertEqual( | ||
| list_response.data['results'][0]['owner_label'], | ||
| asset_owner_username | ||
| ) | ||
|
|
||
| # Mock the is_mmo property to simulate a multi-member organization | ||
| with mock.patch.object(Organization, 'is_mmo', return_value=True): | ||
| list_response = self.client.get(self.list_url) | ||
|
|
||
| # Verify the owner_label now reflects the organization's name | ||
| self.assertEqual( | ||
| list_response.data['results'][0]['owner_label'], | ||
| asset_owner.organization.name | ||
| ) | ||
|
|
||
| # Assign a new user as the organization owner | ||
| another_user = User.objects.get(username='anotheruser') | ||
| another_org_user = OrganizationUser.objects.create( | ||
| organization=asset_owner.organization, | ||
| user=another_user, | ||
| is_admin=True | ||
| ) | ||
| org_owner = OrganizationOwner.objects.get( | ||
| organization=asset_owner.organization | ||
| ) | ||
| org_owner.organization_user = another_org_user | ||
| org_owner.save() |
There was a problem hiding this comment.
I think the test should be different.
- Make
asset_ownerorganization a MMO (setmmo_overrideto True) - Add another user (anotheruser) to
asset_ownerorganization (asset_owner.organization.add_user(another_user)) - Share asset with anotheruser (
assign_perm(anotheruser, PERM_VIEW_ASSET)) - Create another asset with an external user and share it with anotheruser.
- Test the endpoint (with anotheruser logged in) that returns the org' name for first asset and external username for the second asset.
- Test the endpoint (with external user logged in) that returns external user's username
Comment on lines
+725
to
+735
| # 5) Get organization per asset | ||
| assets = ( | ||
| Asset.objects.filter(id__in=asset_ids) | ||
| .prefetch_related('owner__organizations_organization') | ||
| ) | ||
| organization_by_asset = defaultdict(dict) | ||
| for asset in assets: | ||
| organization = getattr(asset.owner, 'organization', None) | ||
| organization_by_asset[asset.id] = organization | ||
| context_['organization_by_asset'] = organization_by_asset | ||
|
|
There was a problem hiding this comment.
Do we have the same optimization for ./api/v2/organizations/<organization_id>/assets/?
Nevermind, the (asset org) endpoint is always showing the same org. @cache_for_request should help to avoid making multiple queries.
rajpatel24
force-pushed
the
task-1181-add-owner_label-field-to-asset-serializer
branch
from
e6b5d52
to
d4e6c47
Compare
rajpatel24
force-pushed
the
task-1181-add-owner_label-field-to-asset-serializer
branch
from
d4e6c47
to
0fe5035
Compare
|
#5324 will be add more optimization to this PR. |
… github.com:kobotoolbox/kpi into task-1181-add-owner_label-field-to-asset-serializer
rajpatel24
deleted the
task-1181-add-owner_label-field-to-asset-serializer
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗒️ Checklist
<type>(<scope>)<!>: <title> TASK-1234frontendorbackendunless it's global📣 Summary
Added
owner_labelfield to the Asset API to clarify ownership information, dynamically reflecting either the owner's username or the organization's name.📖 Description
The
owner_labelfield in the Asset API now dynamically displays:This enhancement improves clarity by providing contextual ownership details directly in the API response.
👷 Description for instance maintainers
This update introduces a new owner_label field in the Asset serializer:
👀 Preview steps
💭 Notes