Add Dandiset star functionality with UI components

dandiapi/api/admin.py

@@ -21,6 +21,7 @@
     AssetBlob,
     AuditRecord,
     Dandiset,
+    DandisetStar,
     Upload,
     UserMetadata,
     Version,
@@ -266,3 +267,12 @@ def has_change_permission(self, request, obj=None):
 
     def has_delete_permission(self, request, obj=None):
         return False
+
+
+@admin.register(DandisetStar)
+class DandisetStarAdmin(admin.ModelAdmin):
+    list_display = ('user', 'dandiset', 'created')
+    list_filter = ('created',)
+    search_fields = ('user__username', 'dandiset__id')
+    raw_id_fields = ('user', 'dandiset')
+    date_hierarchy = 'created'

dandiapi/api/migrations/0014_dandisetstar.py

@@ -0,0 +1,53 @@
+# Generated by Django 4.2.17 on 2025-01-03 21:10
+from __future__ import annotations
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('api', '0013_remove_assetpath_consistent_slash_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DandisetStar',
+            fields=[
+                (
+                    'id',
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name='ID',
+                    ),
+                ),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                (
+                    'dandiset',
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name='stars',
+                        to='api.dandiset',
+                    ),
+                ),
+                (
+                    'user',
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name='starred_dandisets',
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+        ),
+        migrations.AddConstraint(
+            model_name='dandisetstar',
+            constraint=models.UniqueConstraint(
+                fields=('user', 'dandiset'), name='unique-user-dandiset-star'
+            ),
+        ),
+    ]

dandiapi/api/models/__init__.py

@@ -3,7 +3,7 @@
 from .asset import Asset, AssetBlob
 from .asset_paths import AssetPath, AssetPathRelation
 from .audit import AuditRecord
-from .dandiset import Dandiset
+from .dandiset import Dandiset, DandisetStar
 from .oauth import StagingApplication
 from .upload import Upload
 from .user import UserMetadata
@@ -16,6 +16,7 @@
     'AssetPathRelation',
     'AuditRecord',
     'Dandiset',
+    'DandisetStar',
     'StagingApplication',
     'Upload',
     'UserMetadata',

dandiapi/api/models/dandiset.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from django.contrib.auth.models import User
 from django.db import models
 from django_extensions.db.models import TimeStampedModel
 from guardian.models import GroupObjectPermissionBase, UserObjectPermissionBase
@@ -112,10 +113,33 @@ def published_count(cls):
     def __str__(self) -> str:
         return self.identifier
 
+    @property
+    def star_count(self):
+        return self.stars.count()
+
+    def is_starred_by(self, user):
+        if not user.is_authenticated:
+            return False
+        return self.stars.filter(user=user).exists()
+
 
 class DandisetUserObjectPermission(UserObjectPermissionBase):
     content_object = models.ForeignKey(Dandiset, on_delete=models.CASCADE)
 
 
 class DandisetGroupObjectPermission(GroupObjectPermissionBase):
     content_object = models.ForeignKey(Dandiset, on_delete=models.CASCADE)
+
+
+class DandisetStar(models.Model):
+    user = models.ForeignKey(User, on_delete=models.CASCADE, related_name='starred_dandisets')
+    dandiset = models.ForeignKey(Dandiset, on_delete=models.CASCADE, related_name='stars')
+    created = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        constraints = [
+            models.UniqueConstraint(name='unique-user-dandiset-star', fields=['user', 'dandiset'])
+        ]
+
+    def __str__(self) -> str:
+        return f'Star {self.user.username} ★ {self.dandiset.identifier}'

dandiapi/api/services/dandiset/__init__.py

@@ -3,12 +3,16 @@
 from django.db import transaction
 from guardian.shortcuts import assign_perm
 
-from dandiapi.api.models.dandiset import Dandiset
+from dandiapi.api.models.dandiset import Dandiset, DandisetStar
 from dandiapi.api.models.version import Version
 from dandiapi.api.services import audit
 from dandiapi.api.services.dandiset.exceptions import DandisetAlreadyExistsError
 from dandiapi.api.services.embargo.exceptions import DandisetUnembargoInProgressError
-from dandiapi.api.services.exceptions import AdminOnlyOperationError, NotAllowedError
+from dandiapi.api.services.exceptions import (
+    AdminOnlyOperationError,
+    NotAllowedError,
+    NotAuthenticatedError,
+)
 from dandiapi.api.services.version.metadata import _normalize_version_metadata
 
 
@@ -74,3 +78,39 @@ def delete_dandiset(*, user, dandiset: Dandiset) -> None:
 
         dandiset.versions.all().delete()
         dandiset.delete()
+
+
+def star_dandiset(*, user, dandiset: Dandiset) -> int:
+    """
+    Star a Dandiset for a user.
+
+    Args:
+        user: The user starring the Dandiset.
+        dandiset: The Dandiset to star.
+
+    Returns:
+        The new star count for the Dandiset.
+    """
+    if not user.is_authenticated:
+        raise NotAuthenticatedError
+
+    DandisetStar.objects.get_or_create(user=user, dandiset=dandiset)
+    return dandiset.star_count
+
+
+def unstar_dandiset(*, user, dandiset: Dandiset) -> int:
+    """
+    Unstar a Dandiset for a user.
+
+    Args:
+        user: The user unstarring the Dandiset.
+        dandiset: The Dandiset to unstar.
+
+    Returns:
+        The new star count for the Dandiset.
+    """
+    if not user.is_authenticated:
+        raise NotAuthenticatedError
+
+    DandisetStar.objects.filter(user=user, dandiset=dandiset).delete()
+    return dandiset.star_count

dandiapi/api/services/exceptions.py

@@ -21,5 +21,10 @@ class NotAllowedError(DandiError):
     http_status_code = status.HTTP_403_FORBIDDEN
 
 
+class NotAuthenticatedError(DandiError):
+    message = 'Action requires authentication.'
+    http_status_code = status.HTTP_401_UNAUTHORIZED
+
+
 class AdminOnlyOperationError(DandiError):
     pass