Added: Add translated_content model and update Experiment model (#1208)

* feat: Add translated_content model with FK to experiment and add migrations

* fix: Fix reverse migration

* feat: Remove experiment fields and migrations

The commit removes the `name`, `description`, `consent`, and `about_content` fields from the `Experiment` model and updates the admin forms accordingly.

* refactor: Only show an empty form for a newly to be created experiment

* feat: Add fallback option to get_translated_content method

This commit adds a `fallback` parameter to the `get_translated_content` method in the `Experiment` model. When set to `True`, if no content is found for the specified language, it will return the primary content instead. If `fallback` is set to `False` and no content is found, a `ValueError` will be raised.

Refactor the `get_content` method to `get_translated_content` to better reflect its purpose.

* refactor: Rename primary_content to fallback_content

* fix(test): Fix & update tests after adding experiment translated content

* chore: Rename primary content to fallback content

* refactor: Use `get_language` instead of checking `request.LANGUAGE_CODE`

* refactor: Remove unnecessary code for setting language in get_block view as this has been replaced at the experiment level per #1204

* refactor: Moving setting the language cookie from `get_block` to `get_experiment`

* test: Add tests for getting the right language content based on the `Accept-Language` header's value

* refactor: Delete all experiment translated content

This commit modifies the migration file `0050_migrate_experiment_content_to_translatedmakemigrations.py` to delete all experiment translated content using the `ExperimentTranslatedContent.objects.all().delete()` method. This change is necessary to clean up the database and ensure that no translated content exists anymore after running the reverse migration.

* fix: Fix ci by changing `docker-compose` command to `docker compose`

.github/workflows/ci-backend.yml

@@ -22,16 +22,16 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Run Backend Tests
-        run: sudo docker-compose --env-file .env-github-actions run server bash -c "coverage run manage.py test"
+        run: sudo docker compose --env-file .env-github-actions run server bash -c "coverage run manage.py test"
       - name: Generate Backend Coverage Report (Inline)
-        run: sudo docker-compose --env-file .env-github-actions run server bash -c "coverage report --show-missing"
+        run: sudo docker compose --env-file .env-github-actions run server bash -c "coverage report --show-missing"
 
       # Generate coverage badge (only for main and develop branches)
       - name: Generate Backend Coverage Report (XML) and Badge
         if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop'
         run: |
-          sudo docker-compose --env-file .env-github-actions run server bash -c "coverage xml"
-          sudo docker-compose --env-file .env-github-actions run server bash -c "genbadge coverage -i coverage.xml -o coverage-backend-badge-new.svg -n \"Backend Code Coverage\""
+          sudo docker compose --env-file .env-github-actions run server bash -c "coverage xml"
+          sudo docker compose --env-file .env-github-actions run server bash -c "genbadge coverage -i coverage.xml -o coverage-backend-badge-new.svg -n \"Backend Code Coverage\""
       # Push coverage badge to separate branch (only for main and develop branches)
       - name: Push Backend Coverage Badge to separate branch
         continue-on-error: true
@@ -66,4 +66,4 @@ jobs:
       - uses: actions/checkout@v3
       - name: Lint Backend
         continue-on-error: false
-        run: sudo docker-compose --env-file .env-github-actions run server bash -c "ruff check"
+        run: sudo docker compose --env-file .env-github-actions run server bash -c "ruff check"

.github/workflows/ci-frontend.yml

@@ -22,7 +22,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Run Frontend Tests
-        run: sudo docker-compose --env-file .env-github-actions run client yarn test:ci
+        run: sudo docker compose --env-file .env-github-actions run client yarn test:ci
 
   frontend-coverage-badge:
     name: Generate Frontend Coverage Badge
@@ -33,8 +33,8 @@ jobs:
       - uses: actions/checkout@v3
       - name: Generate Frontend Coverage Report (XML) and Badge
         run: |
-          sudo docker-compose --env-file .env-github-actions run client yarn test:ci
-          sudo docker-compose --env-file .env-github-actions run client yarn coverage-badges -s public/coverage/coverage-summary.json -o public/coverage/coverage-frontend-badge-new.svg --label 'Frontend Code Coverage'
+          sudo docker compose --env-file .env-github-actions run client yarn test:ci
+          sudo docker compose --env-file .env-github-actions run client yarn coverage-badges -s public/coverage/coverage-summary.json -o public/coverage/coverage-frontend-badge-new.svg --label 'Frontend Code Coverage'
       - name: Push Frontend Coverage Badge to separate branch
         continue-on-error: true
         run: |
@@ -65,4 +65,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - run: sudo docker-compose --env-file .env-github-actions run client yarn lint
+      - run: sudo docker compose --env-file .env-github-actions run client yarn lint

backend/experiment/admin.py

@@ -22,6 +22,7 @@
     Phase,
     Feedback,
     SocialMediaConfig,
+    ExperimentTranslatedContent,
 )
 from question.admin import QuestionSeriesInline
 from experiment.forms import (
@@ -45,6 +46,16 @@ class FeedbackInline(admin.TabularInline):
     extra = 0
 
 
+class ExperimentTranslatedContentInline(NestedStackedInline):
+    model = ExperimentTranslatedContent
+    sortable_field_name = "index"
+
+    def get_extra(self, request, obj=None, **kwargs):
+        if obj:
+            return 0
+        return 1
+
+
 class BlockAdmin(InlineActionsModelAdminMixin, admin.ModelAdmin):
     list_display = (
         "image_preview",
@@ -112,36 +123,22 @@ def export(self, request, obj, parent_obj=None):
         zip_buffer = BytesIO()
         with ZipFile(zip_buffer, "w") as new_zip:
             # serialize data to new json files within the zip file
-            new_zip.writestr(
-                "sessions.json", data=str(serializers.serialize("json", all_sessions))
-            )
+            new_zip.writestr("sessions.json", data=str(serializers.serialize("json", all_sessions)))
             new_zip.writestr(
                 "participants.json",
-                data=str(
-                    serializers.serialize("json", all_participants.order_by("pk"))
-                ),
+                data=str(serializers.serialize("json", all_participants.order_by("pk"))),
             )
             new_zip.writestr(
                 "profiles.json",
-                data=str(
-                    serializers.serialize(
-                        "json", all_profiles.order_by("participant", "pk")
-                    )
-                ),
+                data=str(serializers.serialize("json", all_profiles.order_by("participant", "pk"))),
             )
             new_zip.writestr(
                 "results.json",
-                data=str(
-                    serializers.serialize("json", all_results.order_by("session"))
-                ),
+                data=str(serializers.serialize("json", all_results.order_by("session"))),
             )
             new_zip.writestr(
                 "sections.json",
-                data=str(
-                    serializers.serialize(
-                        "json", all_sections.order_by("playlist", "pk")
-                    )
-                ),
+                data=str(serializers.serialize("json", all_sections.order_by("playlist", "pk"))),
             )
             new_zip.writestr(
                 "songs.json",
@@ -152,11 +149,7 @@ def export(self, request, obj, parent_obj=None):
         response = HttpResponse(zip_buffer.getbuffer())
         response["Content-Type"] = "application/x-zip-compressed"
         response["Content-Disposition"] = (
-            'attachment; filename="'
-            + obj.slug
-            + "-"
-            + timezone.now().isoformat()
-            + '.zip"'
+            'attachment; filename="' + obj.slug + "-" + timezone.now().isoformat() + '.zip"'
         )
         return response
 
@@ -170,20 +163,14 @@ def export_csv(self, request, obj, parent_obj=None):
             result_keys = []
             export_options = []
             # Get all export options
-            session_keys = [
-                key for key in request.POST.getlist("export_session_fields")
-            ]
+            session_keys = [key for key in request.POST.getlist("export_session_fields")]
             result_keys = [key for key in request.POST.getlist("export_result_fields")]
             export_options = [key for key in request.POST.getlist("export_options")]
 
             response = HttpResponse(content_type="text/csv")
-            response["Content-Disposition"] = 'attachment; filename="{}.csv"'.format(
-                obj.slug
-            )
+            response["Content-Disposition"] = 'attachment; filename="{}.csv"'.format(obj.slug)
             # Get filtered data
-            block_table, fieldnames = obj.export_table(
-                session_keys, result_keys, export_options
-            )
+            block_table, fieldnames = obj.export_table(session_keys, result_keys, export_options)
             fieldnames.sort()
             writer = csv.DictWriter(response, fieldnames)
             writer.writeheader()
@@ -227,11 +214,7 @@ def block_name_link(self, obj):
 
     def block_slug_link(self, obj):
         dev_mode = settings.DEBUG is True
-        url = (
-            f"http://localhost:3000/block/{obj.slug}"
-            if dev_mode
-            else f"/block/{obj.slug}"
-        )
+        url = f"http://localhost:3000/block/{obj.slug}" if dev_mode else f"/block/{obj.slug}"
 
         return format_html(
             f'<a href="{url}" target="_blank" rel="noopener noreferrer" title="Open {obj.slug} block in new tab" >{obj.slug}&nbsp;<small>&#8599;</small></a>'
@@ -248,21 +231,33 @@ def block_slug_link(self, obj):
 
 class BlockInline(NestedStackedInline):
     model = Block
-    extra = 1
     sortable_field_name = "index"
 
+    def get_extra(self, request, obj=None, **kwargs):
+        if obj:
+            return 0
+        return 1
+
 
 class PhaseInline(NestedTabularInline):
     model = Phase
-    extra = 1
     sortable_field_name = "index"
     inlines = [BlockInline]
 
+    def get_extra(self, request, obj=None, **kwargs):
+        if obj:
+            return 0
+        return 1
+
 
 class SocialMediaConfigInline(NestedStackedInline):
     form = SocialMediaConfigForm
     model = SocialMediaConfig
-    extra = 0
+
+    def get_extra(self, request, obj=None, **kwargs):
+        if obj:
+            return 0
+        return 1
 
 
 class ExperimentAdmin(InlineActionsModelAdminMixin, NestedModelAdmin):
@@ -276,21 +271,22 @@ class ExperimentAdmin(InlineActionsModelAdminMixin, NestedModelAdmin):
     )
     fields = [
         "slug",
-        "name",
         "active",
-        "description",
-        "consent",
         "theme_config",
         "dashboard",
-        "about_content",
     ]
     inline_actions = ["dashboard"]
     form = ExperimentForm
     inlines = [
+        ExperimentTranslatedContentInline,
         PhaseInline,
         SocialMediaConfigInline,
     ]
 
+    def name(self, obj):
+        content = obj.get_fallback_content()
+        return content.name if content else "No name"
+
     def slug_link(self, obj):
         dev_mode = settings.DEBUG is True
         url = f"http://localhost:3000/{obj.slug}" if dev_mode else f"/{obj.slug}"
@@ -300,20 +296,16 @@ def slug_link(self, obj):
         )
 
     def description_excerpt(self, obj):
-        if len(obj.description) < 50:
-            return obj.description
+        description = obj.get_fallback_content().description or "No description"
+        if len(description) < 50:
+            return description
 
-        return obj.description[:50] + "..."
+        return description[:50] + "..."
 
     def phases(self, obj):
         phases = Phase.objects.filter(series=obj)
         return format_html(
-            ", ".join(
-                [
-                    f'<a href="/admin/experiment/phase/{phase.id}/change/">{phase.name}</a>'
-                    for phase in phases
-                ]
-            )
+            ", ".join([f'<a href="/admin/experiment/phase/{phase.id}/change/">{phase.name}</a>' for phase in phases])
         )
 
     slug_link.short_description = "Slug"
@@ -380,7 +372,9 @@ def name_link(self, obj):
 
     def related_experiment(self, obj):
         url = reverse("admin:experiment_experiment_change", args=[obj.series.pk])
-        return format_html('<a href="{}">{}</a>', url, obj.series.name)
+        content = obj.series.get_fallback_content()
+        experiment_name = content.name if content else "No name"
+        return format_html('<a href="{}">{}</a>', url, experiment_name)
 
     def blocks(self, obj):
         blocks = Block.objects.filter(phase=obj)
@@ -389,12 +383,7 @@ def blocks(self, obj):
             return "No blocks"
 
         return format_html(
-            ", ".join(
-                [
-                    f'<a href="/admin/experiment/block/{block.id}/change/">{block.name}</a>'
-                    for block in blocks
-                ]
-            )
+            ", ".join([f'<a href="/admin/experiment/block/{block.id}/change/">{block.name}</a>' for block in blocks])
         )