Allow users to add reference materials (#297)

* Allow users to add reference materials

* Model vetting details per user

* Update vetting details from front end

* Use separate component for reference materials

* Add length check and test to API layer

* Swap position of close/save for consistency

* Use correct max length value for vuetify rule

Co-authored-by: Bryon Lewis <61746913+BryonLewis@users.noreply.github.com>

---------

Co-authored-by: Bryon Lewis <61746913+BryonLewis@users.noreply.github.com>

Author: naglepuff

bats_ai/api.py

@@ -13,6 +13,7 @@
     RecordingRouter,
     RecordingTagRouter,
     SpeciesRouter,
+    VettingRouter,
 )
 from bats_ai.core.views.nabat import NABatConfigurationRouter, NABatRecordingRouter
 
@@ -46,3 +47,4 @@ def global_auth(request):
 api.add_router('/recording-tag/', RecordingTagRouter)
 api.add_router('/nabat/recording/', NABatRecordingRouter)
 api.add_router('/nabat/configuration/', NABatConfigurationRouter)
+api.add_router('/vetting/', VettingRouter)

bats_ai/core/admin/__init__.py

@@ -18,6 +18,7 @@
 from .species import SpeciesAdmin
 from .spectrogram import SpectrogramAdmin
 from .spectrogram_image import SpectrogramImageAdmin
+from .vetting_details import VettingDetailsAdmin
 
 __all__ = [
     'AnnotationsAdmin',
@@ -34,6 +35,7 @@
     'ConfigurationAdmin',
     'ExportedAnnotationFileAdmin',
     'SpectrogramImageAdmin',
+    'VettingDetailsAdmin',
     # NABat Models
     'NABatRecordingAnnotationAdmin',
     'NABatCompressedSpectrogramAdmin',

bats_ai/core/admin/vetting_details.py

@@ -0,0 +1,13 @@
+from django.contrib import admin
+
+from bats_ai.core.models import VettingDetails
+
+
+@admin.register(VettingDetails)
+class VettingDetailsAdmin(admin.ModelAdmin):
+    list_display = [
+        'pk',
+        'user',
+        # 'reference_materials',
+    ]
+    search_fields = ('user',)

bats_ai/core/migrations/0025_vettingdetails_and_more.py

@@ -0,0 +1,41 @@
+# Generated by Django 4.2.23 on 2026-01-08 18:57
+
+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),
+        ('core', '0024_configuration_mark_annotations_completed_enabled_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='VettingDetails',
+            fields=[
+                (
+                    'id',
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name='ID'
+                    ),
+                ),
+                ('reference_materials', models.TextField(blank=True)),
+                (
+                    'user',
+                    models.OneToOneField(
+                        on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL
+                    ),
+                ),
+            ],
+        ),
+        migrations.AddConstraint(
+            model_name='vettingdetails',
+            constraint=models.CheckConstraint(
+                check=models.Q(('reference_materials__length__lte', 2000)),
+                name='reference_materials_max_2000',
+            ),
+        ),
+    ]

bats_ai/core/models/__init__.py

@@ -12,6 +12,7 @@
 from .species import Species
 from .spectrogram import Spectrogram
 from .spectrogram_image import SpectrogramImage
+from .vetting_details import VettingDetails
 
 __all__ = [
     'Annotations',
@@ -30,4 +31,5 @@
     'ProcessingTaskType',
     'ExportedAnnotationFile',
     'SpectrogramImage',
+    'VettingDetails',
 ]

bats_ai/core/models/vetting_details.py

@@ -0,0 +1,20 @@
+from django.contrib.auth.models import User
+from django.db import models
+from django.db.models import Q
+from django.db.models.functions import Length
+
+models.TextField.register_lookup(Length, 'length')
+
+
+class VettingDetails(models.Model):
+    user = models.OneToOneField(User, on_delete=models.CASCADE)
+    reference_materials = models.TextField(blank=True)
+
+    class Meta:
+        constraints = [
+            models.CheckConstraint(
+                # TODO change to 'condition' in Django v6
+                check=Q(reference_materials__length__lte=2000),
+                name='reference_materials_max_2000',
+            )
+        ]

bats_ai/core/tests/conftest.py

@@ -2,7 +2,9 @@
 from django.test import Client
 import pytest
 
-from .factories import SuperuserFactory, UserFactory
+from bats_ai.core.models import VettingDetails
+
+from .factories import SuperuserFactory, UserFactory, VettingDetailsFactory
 
 
 @pytest.fixture
@@ -32,3 +34,13 @@ def authorized_client(superuser: User) -> Client:
     client = Client()
     client.force_login(user=superuser)
     return client
+
+
+@pytest.fixture
+def vetting_details(user: User) -> VettingDetails:
+    return VettingDetailsFactory(user=user)
+
+
+@pytest.fixture
+def random_user_vetting_details() -> VettingDetails:
+    return VettingDetailsFactory(user=UserFactory())

bats_ai/core/tests/factories.py

@@ -1,6 +1,8 @@
 from django.contrib.auth.models import User
 import factory.django
 
+from bats_ai.core.models import VettingDetails
+
 
 class UserFactory(factory.django.DjangoModelFactory[User]):
     class Meta:
@@ -28,3 +30,12 @@ class Meta:
     def _create(cls, model_class, *args, **kwargs):
         manager = cls._get_manager(model_class)
         return manager.create_superuser(*args, **kwargs)
+
+
+class VettingDetailsFactory(factory.django.DjangoModelFactory[VettingDetails]):
+
+    class Meta:
+        model = VettingDetails
+
+    user = factory.SubFactory(UserFactory)
+    reference_materials = factory.Faker('paragraph', nb_sentences=3)

bats_ai/core/tests/test_vetting_details.py

@@ -0,0 +1,114 @@
+import pytest
+
+from .factories import UserFactory, VettingDetailsFactory
+
+
+@pytest.mark.parametrize(
+    'client_fixture,status_code',
+    [
+        ('client', 401),
+        ('authenticated_client', 200),
+        ('authorized_client', 200),
+    ],
+)
+@pytest.mark.django_db
+def test_get_vetting_details(client_fixture, status_code, user, vetting_details, request):
+    api_client = request.getfixturevalue(client_fixture)
+    resp = api_client.get(f'/api/v1/vetting/user/{user.id}')
+    assert resp.status_code == status_code
+    if status_code == 200:
+        assert resp.json()['reference_materials'] == vetting_details.reference_materials
+
+
+@pytest.mark.django_db
+def test_get_vetting_details_other_user(authenticated_client):
+    other_user = UserFactory()
+    VettingDetailsFactory(user=other_user)
+    resp = authenticated_client.get(f'/api/v1/vetting/user/{other_user.id}')
+    assert resp.status_code == 404
+
+
+@pytest.mark.django_db
+def test_create_vetting_details(client):
+    test_text = 'foo'
+    data = {'reference_materials': test_text}
+    test_user = UserFactory()
+    client.force_login(user=test_user)
+    resp = client.post(
+        f'/api/v1/vetting/user/{test_user.id}', data=data, content_type='application/json'
+    )
+    assert resp.status_code == 200
+    assert resp.json()['user_id'] == test_user.id
+
+
+@pytest.mark.parametrize(
+    'client_fixture,status_code',
+    [
+        ('authenticated_client', 404),
+        ('authorized_client', 200),
+    ],
+)
+@pytest.mark.django_db
+def test_create_vetting_details_other_user(client_fixture, status_code, request):
+    api_client = request.getfixturevalue(client_fixture)
+    test_text = 'foo'
+    data = {'reference_materials': test_text}
+    other_user = UserFactory()
+    resp = api_client.post(
+        f'/api/v1/vetting/user/{other_user.id}', data=data, content_type='application/json'
+    )
+    assert resp.status_code == status_code
+    if status_code == 200:
+        assert resp.json()['reference_materials'] == test_text
+
+
+@pytest.mark.django_db
+def test_update_vetting_details(client):
+    test_text = 'bar'
+    data = {'reference_materials': 'bar'}
+    test_user = UserFactory()
+    VettingDetailsFactory(user=test_user, reference_materials='foo')
+    client.force_login(test_user)
+
+    initial_resp = client.get(f'/api/v1/vetting/user/{test_user.id}')
+    assert initial_resp.status_code == 200
+
+    resp = client.post(
+        f'/api/v1/vetting/user/{test_user.id}', data=data, content_type='application/json'
+    )
+    assert resp.status_code == 200
+
+    new_details_response = client.get(f'/api/v1/vetting/user/{test_user.id}')
+    assert new_details_response.status_code == 200
+    assert new_details_response.json()['reference_materials'] == test_text
+
+
+@pytest.mark.parametrize(
+    'client_fixture,status_code',
+    [
+        ('authenticated_client', 404),
+        ('authorized_client', 200),
+    ],
+)
+@pytest.mark.django_db
+def test_update_vetting_details_other_user(
+    client_fixture, status_code, random_user_vetting_details, request
+):
+    api_client = request.getfixturevalue(client_fixture)
+    resp = api_client.post(
+        f'/api/v1/vetting/user/{random_user_vetting_details.user.id}',
+        data={'reference_materials': 'foo'},
+        content_type='application/json',
+    )
+    assert resp.status_code == status_code
+
+
+@pytest.mark.django_db
+def test_update_vetting_details_length_constraint(authorized_client, random_user_vetting_details):
+    data = {'reference_materials': 'a' * 2001}
+    resp = authorized_client.post(
+        f'/api/v1/vetting/user/{random_user_vetting_details.user.id}',
+        data=data,
+        content_type='application/json',
+    )
+    assert resp.status_code == 400

bats_ai/core/views/__init__.py

@@ -9,6 +9,7 @@
 from .recording_tag import router as RecordingTagRouter
 from .sequence_annotations import router as SequenceAnnotationRouter
 from .species import router as SpeciesRouter
+from .vetting_details import router as VettingRouter
 
 __all__ = [
     'RecordingRouter',
@@ -22,4 +23,5 @@
     'ProcessingTaskRouter',
     'ExportAnnotationRouter',
     'RecordingTagRouter',
+    'VettingRouter',
 ]