Add Dandiset star functionality with UI components #2123

bendichter · 2024-12-26T15:42:15Z

Feature developed with Cursor

Introduced DandisetStar model and admin interface for managing starred Dandisets.
Implemented star/unstar actions in the DandisetViewSet and corresponding API endpoints.
Added star count and starred status to DandisetSerializer.
Created StarButton component for toggling star status in the UI.
Developed StarredDandisetsView to display Dandisets starred by the user.
Updated DandisetList and DandisetLandingView to include star functionality.
Enhanced DandisetFilterBackend to support ordering by star count.
Update existing tests and add new tests
Add package-lock.json to ignore list for spell check

I haven't been able to log in on my dev server so I can't test that behavior, but the unlogged in web UI and the admin interface appear to work as expected

waxlamp

Very interesting!

I'm a dinosaur who's not ready to trust AI-generated code just yet, so I'll want to get careful reviews from @jjnesbitt and @mvandenburgh (both to identify problems with the code, and so we have team members with a mental model of how it works) before merging. Furthermore, I think this will benefit from some enhancements (like using a service layer to manage stars), as well as some minor stuff that I can push fixes for myself. Finally, I would like for @jtomeck to help out with the frontend design here as well.

Thanks @bendichter for kicking this feature off!

web/package-lock.json

web/yarn.lock

bendichter · 2024-12-26T18:17:59Z

@waxlamp yes, I mentioned Cursor because I agree that this will need careful eyes on it before integrating. But looking at the changes the majority of them seem straightforward

.pre-commit-config.yaml

bendichter · 2024-12-26T18:26:35Z

ok yeah the npm-related issues are my fault. I am used to installing with npm and having large automatically generated files as a result of that. I'll make sure to use yarn in the future.

bendichter · 2024-12-27T01:23:46Z

I don't know what to do about the remaining CI check failures

jjnesbitt

Thanks for the work, @bendichter. I've done a first pass of this PR and identified some necessary changes, but nonetheless it's great to have the outline of this feature out of the way.

I'd be happy to address some of these changes myself, if that makes more sense. I'll still leave the comments either way.

dandiapi/api/services/dandiset/__init__.py

dandiapi/api/views/dandiset.py

dandiapi/api/views/serializers.py

web/yarn.lock

web/src/components/StarButton.vue

web/src/router.ts

web/src/views/StarredDandisetsView/StarredDandisetsView.vue

bendichter · 2024-12-29T19:07:52Z

@jjnesbitt thanks for the prompt and thorough review. I can confirm that I can replicate those UI bugs. I might have time to address them myself but feel free to take this over if you have the bandwidth to do so.

jjnesbitt · 2024-12-30T16:17:05Z

@jjnesbitt thanks for the prompt and thorough review. I can confirm that I can replicate those UI bugs. I might have time to address them myself but feel free to take this over if you have the bandwidth to do so.

I think I have the bandwidth, so today I can make a pass at changing someone of the things I mentioned.

dandiapi/api/views/version.py

mvandenburgh

We'll also need to add audit events for starring/unstarring a dandiset.

jjnesbitt · 2025-01-03T22:19:59Z

We'll also need to add audit events for starring/unstarring a dandiset.

For posterity: We met offline and agreed to exclude dandiset stars from audit events.

- Introduced DandisetStar model and admin interface for managing starred Dandisets. - Implemented star/unstar actions in the DandisetViewSet and corresponding API endpoints. - Added star count and starred status to DandisetSerializer. - Created StarButton component for toggling star status in the UI. - Developed StarredDandisetsView to display Dandisets starred by the user. - Updated DandisetList and DandisetLandingView to include star functionality. - Enhanced DandisetFilterBackend to support ordering by star count.

- Updated test cases in test_dandiset.py and test_version.py to include 'star_count' and 'is_starred' fields in the expected responses. - Ensured consistency across various test scenarios for Dandiset and Version APIs regarding star functionality.

unique_together is deprecated

mvandenburgh

@jjnesbitt just one point about the failure conditions for starring/unstarring. I think you could make an argument for either way (i.e., starring/unstarring is idempotent and always returns a 2xx as it is now, vs. verifying validity of the request and possibly rejecting it with a 4xx), any thoughts?

dandiapi/api/services/dandiset/__init__.py

jjnesbitt · 2025-01-30T18:27:46Z

@jjnesbitt just one point about the failure conditions for starring/unstarring. I think you could make an argument for either way (i.e., starring/unstarring is idempotent and always returns a 2xx as it is now, vs. verifying validity of the request and possibly rejecting it with a 4xx), any thoughts?

IMO the star/unstar operation should be idempotent. Raising an error in this case doesn't really provide us with much benefit.

It can actually lead to an undesirable outcome in the following situation:

User has a dandiset open in two tabs for some reason.
In the first tab they star the dandiset, showing it reflected as being starred.
Later, in the second tab, they see it isn't starred for some reason, and hit star again. Since the front-end is out of sync with the back-end, that would call /star again, and raise an exception.

This is unnecessarily confusing to the user with no real upside. It's not like the user can do anything, and we couldn't really do anything either, except for try to prevent that situation from occurring in the first place.

waxlamp

This looks great, and I don't wish to hold up merge-and-deploy any longer, but I did have some questions and some minor suggestions in case they're useful.

dandiapi/api/tests/test_dandiset.py

dandiapi/api/views/dandiset.py

dandiapi/api/services/dandiset/__init__.py

dandiapi/api/models/dandiset.py

Co-authored-by: Roni Choudhury <[email protected]>

waxlamp

I have a remaining suggestion about unifiying two functions, but I'm leaving that to your discretion -- this looks ready to go.

dandiapi/api/views/dandiset.py

dandibot · 2025-02-05T20:47:12Z

🚀 PR was released in v0.4.16 🚀

kabilar · 2025-02-05T21:00:18Z

Great work team. This is a really nice feature. I tested on staging and production, and it is working well.

bendichter marked this pull request as draft December 26, 2024 16:50

waxlamp requested review from mvandenburgh and jjnesbitt December 26, 2024 17:44

waxlamp reviewed Dec 26, 2024

View reviewed changes

yarikoptic reviewed Dec 26, 2024

View reviewed changes

web/package-lock.json Outdated Show resolved Hide resolved

yarikoptic reviewed Dec 26, 2024

View reviewed changes

web/yarn.lock Outdated Show resolved Hide resolved

bendichter commented Dec 26, 2024

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

bendichter marked this pull request as ready for review December 27, 2024 01:23

jjnesbitt requested changes Dec 27, 2024

View reviewed changes

jjnesbitt force-pushed the stars branch 4 times, most recently from c2b200c to 0d1aace Compare December 31, 2024 19:14

jjnesbitt reviewed Dec 31, 2024

View reviewed changes

dandiapi/api/views/version.py Show resolved Hide resolved

mvandenburgh requested changes Dec 31, 2024

View reviewed changes

jjnesbitt force-pushed the stars branch from fa9eb7f to a83ba49 Compare January 3, 2025 22:17

jjnesbitt requested a review from mvandenburgh January 3, 2025 22:19

jjnesbitt force-pushed the stars branch from a83ba49 to 2f82708 Compare January 28, 2025 19:41

bendichter added 6 commits January 28, 2025 12:51

Delete web/src/components/NavigationDrawer.vue

c4c5afc

Delete web/src/stores/auth.ts

b1fa860

Ruff compliance for DandisetStar model and admin integration

9d11b34

Update pre-commit configuration to exclude package-lock.json from checks

9d8bb01

jjnesbitt added 8 commits January 28, 2025 12:54

Incorporate starred dandisets into dandiset list endpoint

3181921

Fix behavior of starred dandisets page

31e1663

Revert change to yarn.lock

4996581

Fix missing context for version detail serializer

056d90b

Fix behavior of StarButton

a9a4af8

Replace unique_together with UniqueConstraint

3772254

unique_together is deprecated

Move authentication check into star service functions

0e7c7c3

Fix conflict in migrations

c3b922a

jjnesbitt force-pushed the stars branch from 2f82708 to c3b922a Compare January 28, 2025 20:00

Replace excessive return statements with variable assignment

910e52f

jjnesbitt requested a review from waxlamp January 28, 2025 20:30

mvandenburgh reviewed Jan 30, 2025

View reviewed changes

dandiapi/api/services/dandiset/__init__.py Show resolved Hide resolved

dandiapi/api/services/dandiset/__init__.py Show resolved Hide resolved

mvandenburgh approved these changes Jan 30, 2025

View reviewed changes

waxlamp approved these changes Feb 4, 2025

View reviewed changes

dandiapi/api/tests/test_dandiset.py Outdated Show resolved Hide resolved

dandiapi/api/views/dandiset.py Outdated Show resolved Hide resolved

dandiapi/api/services/dandiset/__init__.py Show resolved Hide resolved

dandiapi/api/models/dandiset.py Outdated Show resolved Hide resolved

jjnesbitt and others added 2 commits February 5, 2025 12:29

Update dandiapi/api/tests/test_dandiset.py

c35352d

Co-authored-by: Roni Choudhury <[email protected]>

Use DELETE rest method for dandiset un-star

afe79a3

jjnesbitt force-pushed the stars branch from 2bb1035 to afe79a3 Compare February 5, 2025 17:38

Add starred_users m2m relation to Dandiset model

4a02dbe

waxlamp approved these changes Feb 5, 2025

View reviewed changes

dandiapi/api/views/dandiset.py Outdated Show resolved Hide resolved

Unify star and unstar view functions

fe47e36

waxlamp approved these changes Feb 5, 2025

View reviewed changes

jjnesbitt added patch Increment the patch version when merged release Create a release when this pr is merged labels Feb 5, 2025

jjnesbitt approved these changes Feb 5, 2025

View reviewed changes

jjnesbitt merged commit 6e31d43 into master Feb 5, 2025
11 checks passed

jjnesbitt deleted the stars branch February 5, 2025 20:46

dandibot added the released This issue/pull request has been released. label Feb 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Dandiset star functionality with UI components #2123

Add Dandiset star functionality with UI components #2123

bendichter commented Dec 26, 2024 •

edited

Loading

waxlamp left a comment

bendichter commented Dec 26, 2024

bendichter commented Dec 26, 2024

bendichter commented Dec 27, 2024

jjnesbitt left a comment

bendichter commented Dec 29, 2024 •

edited

Loading

jjnesbitt commented Dec 30, 2024 •

edited

Loading

mvandenburgh left a comment

jjnesbitt commented Jan 3, 2025

mvandenburgh left a comment

jjnesbitt commented Jan 30, 2025

waxlamp left a comment

waxlamp left a comment

dandibot commented Feb 5, 2025

kabilar commented Feb 5, 2025

Add Dandiset star functionality with UI components #2123

Add Dandiset star functionality with UI components #2123

Conversation

bendichter commented Dec 26, 2024 • edited Loading

waxlamp left a comment

Choose a reason for hiding this comment

bendichter commented Dec 26, 2024

bendichter commented Dec 26, 2024

bendichter commented Dec 27, 2024

jjnesbitt left a comment

Choose a reason for hiding this comment

bendichter commented Dec 29, 2024 • edited Loading

jjnesbitt commented Dec 30, 2024 • edited Loading

mvandenburgh left a comment

Choose a reason for hiding this comment

jjnesbitt commented Jan 3, 2025

mvandenburgh left a comment

Choose a reason for hiding this comment

jjnesbitt commented Jan 30, 2025

waxlamp left a comment

Choose a reason for hiding this comment

waxlamp left a comment

Choose a reason for hiding this comment

dandibot commented Feb 5, 2025

kabilar commented Feb 5, 2025

bendichter commented Dec 26, 2024 •

edited

Loading

bendichter commented Dec 29, 2024 •

edited

Loading

jjnesbitt commented Dec 30, 2024 •

edited

Loading