Breadcrumbs improvements

marcoacierno · marcoacierno · commit 60aeb9dc6d47 · 2024-12-20T16:23:08.000+01:00
diff --git a/backend/conferences/admin/conference.py b/backend/conferences/admin/conference.py
@@ -1,3 +1,4 @@
+import json
 from django.template.response import TemplateResponse
 from pathlib import Path
 from django.core.files.storage import storages
@@ -213,12 +214,33 @@ def schedule_builder(self, request, object_id):
             arguments={
                 "conference_id": object_id,
                 "conference_code": conference.code,
-                "conference_repr": str(conference),
+                "breadcrumbs": json.dumps(
+                    self._build_schedule_builder_breadcrumbs(conference)
+                ),
             },
             title="Schedule Builder",
         )
         return TemplateResponse(request, "astro/schedule-builder.html", context)
 
+    def _build_schedule_builder_breadcrumbs(self, conference):
+        return [
+            {
+                "title": "Conferences",
+                "url": reverse("admin:app_list", kwargs={"app_label": "conferences"}),
+            },
+            {
+                "title": str(conference._meta.verbose_name_plural),
+                "url": reverse("admin:conferences_conference_changelist"),
+            },
+            {
+                "title": str(conference),
+                "url": reverse(
+                    "admin:conferences_conference_change", args=[conference.id]
+                ),
+            },
+            {"title": "Schedule Builder", "url": None},
+        ]
+
     def map_videos(self, request, object_id):
         if request.method == "POST":
             data = request.POST
diff --git a/backend/custom_admin/src/components/invitation-letter-document-builder/builder.tsx b/backend/custom_admin/src/components/invitation-letter-document-builder/builder.tsx
@@ -65,7 +65,7 @@ export const InvitationLetterBuilder = () => {
       </Box>
 
       <Box height="var(--space-3)" />
-      <Box position="sticky" bottom="0" p="3" className="bg-white">
+      <Box position="sticky" bottom="0" p="3" className="bg-white border-t-2">
         <Button onClick={saveChanges} loading={isSaving}>
           Save changes
         </Button>
diff --git a/backend/custom_admin/src/components/invitation-letter-document-builder/editor.tsx b/backend/custom_admin/src/components/invitation-letter-document-builder/editor.tsx
@@ -3,9 +3,7 @@ import ListItem from "@tiptap/extension-list-item";
 import TextAlign from "@tiptap/extension-text-align";
 import TextStyle from "@tiptap/extension-text-style";
 import { EditorContent, useEditor } from "@tiptap/react";
-import { useCurrentEditor } from "@tiptap/react";
 import StarterKit from "@tiptap/starter-kit";
-import React from "react";
 import { MenuBar } from "./menu-bar";
 
 const extensions = [
diff --git a/backend/custom_admin/src/components/invitation-letter-document-builder/root.tsx b/backend/custom_admin/src/components/invitation-letter-document-builder/root.tsx
@@ -6,9 +6,7 @@ import { LocalStateProvider } from "./local-state";
 export const InvitationLetterDocumentBuilderRoot = () => {
   return (
     <Base>
-      <DjangoAdminLayout
-        breadcrumbs={[{ id: 0, label: "Invitation Letter Document Builder" }]}
-      >
+      <DjangoAdminLayout>
         <LocalStateProvider>
           <InvitationLetterBuilder />
         </LocalStateProvider>
diff --git a/backend/custom_admin/src/components/schedule-builder/root.tsx b/backend/custom_admin/src/components/schedule-builder/root.tsx
@@ -17,8 +17,7 @@ export const ScheduleBuilderRoot = () => {
 };
 
 const ScheduleBuilder = () => {
-  const { conferenceCode, conferenceId, conferenceRepr } =
-    useCurrentConference();
+  const { conferenceCode } = useCurrentConference();
   const { error, loading, data } = useConferenceScheduleQuery({
     variables: {
       conferenceCode,
@@ -30,18 +29,7 @@ const ScheduleBuilder = () => {
   } = data ?? { conference: {} };
 
   return (
-    <DjangoAdminLayout
-      breadcrumbs={[
-        { id: 0, label: "Conferences", url: "/admin/conferences" },
-        { id: 1, label: "Conferences", url: "/admin/conferences/conference" },
-        {
-          id: 2,
-          label: conferenceRepr,
-          url: `/admin/conferences/conference/${conferenceId}`,
-        },
-        { id: 3, label: "Schedule Builder" },
-      ]}
-    >
+    <DjangoAdminLayout>
       {loading && <h2>Please wait</h2>}
       {!loading && error && (
         <h2>Something went wrong. Make sure you have the right permissions.</h2>
diff --git a/backend/custom_admin/src/components/shared/base.tsx b/backend/custom_admin/src/components/shared/base.tsx
@@ -4,7 +4,6 @@ import { DndProvider } from "react-dnd";
 import { HTML5Backend } from "react-dnd-html5-backend";
 
 import "../shared/styles.css";
-import * as Toast from "@radix-ui/react-toast";
 import { DjangoAdminEditorProvider } from "./django-admin-editor-modal";
 
 type Props = {
diff --git a/backend/custom_admin/src/components/shared/django-admin-layout.tsx b/backend/custom_admin/src/components/shared/django-admin-layout.tsx
@@ -2,17 +2,16 @@ import clsx from "clsx";
 import React, { Fragment } from "react";
 
 type Breadcrumb = {
-  id: number;
-  label: string;
+  title: string;
   url?: string;
 };
 
 type Props = {
   children: any;
-  breadcrumbs: Breadcrumb[];
 };
 
-export const DjangoAdminLayout = ({ children, breadcrumbs }: Props) => {
+export const DjangoAdminLayout = ({ children }: Props) => {
+  const breadcrumbs: Breadcrumb[] = JSON.parse((window as any).breadcrumbs);
   return (
     <div>
       <Header />
@@ -37,22 +36,28 @@ const Breadcrumbs = ({ breadcrumbs }: { breadcrumbs: Breadcrumb[] }) => {
     <nav aria-label="Breadcrumbs">
       <div className="py-3 px-10 text-white bg-[#79aec8]">
         <span>
-          <a className="hover:text-[#c4dce8] transition-colors" href="/admin">
+          <a
+            className="hover:text-[#c4dce8] transition-colors text-sm"
+            href="/admin"
+          >
             Home
           </a>
         </span>
         <span>{" \u203a "}</span>
         {breadcrumbs.map((breadcrumb, index) => {
           const last = index === breadcrumbs.length - 1;
           return (
-            <span key={breadcrumb.id}>
+            <span key={index}>
               <a
                 href={breadcrumb.url}
-                className={clsx("hover:text-[#c4dce8] transition-colors", {
-                  "text-[#c4dce8]": last,
-                })}
+                className={clsx(
+                  "hover:text-[#c4dce8] transition-colors text-sm",
+                  {
+                    "text-[#c4dce8]": last,
+                  },
+                )}
               >
-                {breadcrumb.label}
+                {breadcrumb.title}
               </a>
               {!last && <span>{" \u203a "}</span>}
             </span>
diff --git a/backend/custom_admin/src/components/utils/conference.tsx b/backend/custom_admin/src/components/utils/conference.tsx
@@ -1,11 +1,9 @@
 export const useCurrentConference = (): {
   conferenceCode: string;
   conferenceId: string;
-  conferenceRepr: string;
 } => {
   return {
     conferenceId: (window as any).conferenceId,
     conferenceCode: (window as any).conferenceCode,
-    conferenceRepr: (window as any).conferenceRepr,
   };
 };
diff --git a/backend/custom_admin/src/pages/invitation-letter-document-builder.astro b/backend/custom_admin/src/pages/invitation-letter-document-builder.astro
@@ -22,6 +22,7 @@ import { InvitationLetterDocumentBuilderRoot } from "../components/invitation-le
 
         window.apolloGraphQLUrl = '/admin/graphql';
         window.documentId = getArg('document_id', "{{ document_id }}");
+        window.breadcrumbs = getArg('breadcrumbs', "{{ breadcrumbs }}");
         </script>
     </body>
 </html>
diff --git a/backend/custom_admin/src/pages/schedule-builder.astro b/backend/custom_admin/src/pages/schedule-builder.astro
@@ -22,7 +22,7 @@ import { ScheduleBuilderRoot } from "../components/schedule-builder/root";
         window.apolloGraphQLUrl = '/admin/graphql';
         window.conferenceId = getArg('conference_id', "{{ conference_id }}");
         window.conferenceCode = getArg('conference_code', "{{ conference_code }}");
-        window.conferenceRepr = getArg('conference_repr', "{{ conference_repr }}");
+        window.breadcrumbs = getArg('breadcrumbs', "{{ breadcrumbs }}");
         </script>
     </body>
 </html>
diff --git a/backend/grants/migrations/0025_alter_grant_approved_type.py b/backend/grants/migrations/0025_alter_grant_approved_type.py
@@ -0,0 +1,23 @@
+# Generated by Django 5.1.4 on 2024-12-20 14:23
+
+from django.db import migrations, models
+
+
+def fix_data(apps, schema_editor):
+    Grant = apps.get_model("grants", "Grant")
+    Grant.objects.filter(approved_type="Ticket").update(approved_type="ticket_travel_accommodation")
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('grants', '0024_alter_grant_age_group'),
+    ]
+
+    operations = [
+        migrations.RunPython(fix_data, reverse_code=migrations.RunPython.noop),
+        migrations.AlterField(
+            model_name='grant',
+            name='approved_type',
+            field=models.CharField(blank=True, choices=[('ticket_only', 'Ticket Only'), ('ticket_travel', 'Ticket + Travel'), ('ticket_accommodation', 'Ticket + Accommodation'), ('ticket_travel_accommodation', 'Ticket + Travel + Accommodation')], max_length=30, null=True, verbose_name='approved type'),
+        ),
+    ]
diff --git a/backend/visa/admin.py b/backend/visa/admin.py
@@ -1,3 +1,4 @@
+import json
 from django.utils.safestring import mark_safe
 
 from django.urls import path
@@ -116,7 +117,13 @@ class InvitationLetterAssetInline(admin.TabularInline):
 
 
 class InvitationLetterDocumentInline(OrderedTabularInline):
-    fields = ("document", "edit_dynamic_document", "order", "move_up_down_links")
+    fields = (
+        "name",
+        "document",
+        "edit_dynamic_document",
+        "order",
+        "move_up_down_links",
+    )
     readonly_fields = (
         "order",
         "move_up_down_links",
@@ -142,10 +149,17 @@ def edit_dynamic_document(self, obj):
         return mark_safe(f'<a href="{url}">Edit</a>')
 
     def edit_dynamic_document_view(self, request, config_id, document_id):
+        document = InvitationLetterDocument.objects.get(id=document_id)
+        config = document.invitation_letter_organizer_config
+        assert config.id == config_id
+
         context = dict(
             self.admin_site.each_context(request),
             arguments={
                 "document_id": document_id,
+                "breadcrumbs": json.dumps(
+                    self._create_builder_breadcrumbs(config, document)
+                ),
             },
             title="Invitation Letter Document Builder",
         )
@@ -164,6 +178,29 @@ def get_urls(self):
         ]
         return custom_urls + urls
 
+    def _create_builder_breadcrumbs(self, config, document):
+        return [
+            {
+                "title": "Visa",
+                "url": reverse("admin:app_list", kwargs={"app_label": "visa"}),
+            },
+            {
+                "title": str(config._meta.verbose_name_plural),
+                "url": reverse("admin:visa_invitationletterorganizerconfig_changelist"),
+            },
+            {
+                "title": str(config),
+                "url": reverse(
+                    "admin:visa_invitationletterorganizerconfig_change",
+                    args=[config.id],
+                ),
+            },
+            {
+                "title": f"{str(document)} - Builder",
+                "url": None,
+            },
+        ]
+
 
 @admin.register(InvitationLetterOrganizerConfig)
 class InvitationLetterOrganizerConfigAdmin(
diff --git a/backend/visa/migrations/0006_invitationletterdocument_name_and_more.py b/backend/visa/migrations/0006_invitationletterdocument_name_and_more.py
@@ -0,0 +1,24 @@
+# Generated by Django 5.1.4 on 2024-12-20 14:23
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('visa', '0005_invitationletterasset'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='invitationletterdocument',
+            name='name',
+            field=models.CharField(default='', max_length=300, verbose_name='name'),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='invitationletterrequest',
+            name='status',
+            field=models.CharField(choices=[('PENDING', 'Pending'), ('PROCESSING', 'Processing'), ('PROCESSED', 'Processed'), ('SENT', 'Sent'), ('REJECTED', 'Rejected'), ('FAILED_TO_GENERATE', 'Failed to generate')], default='PENDING', max_length=20, verbose_name='Status'),
+        ),
+    ]
diff --git a/backend/visa/models.py b/backend/visa/models.py
@@ -147,12 +147,16 @@ class InvitationLetterOrganizerConfig(TimeStampedModel):
         verbose_name=_("organizer"),
     )
 
+    def __str__(self):
+        return f"{self.organizer.name} - Invitation Letter Config"
+
 
 def invitation_letter_attached_document_upload_to(instance, filename):
     return f"invitation_letter_attached_documents/{instance.invitation_letter_organizer_config.organizer.slug}/{filename}"
 
 
 class InvitationLetterDocument(OrderedModel, TimeStampedModel):
+    name = models.CharField(_("name"), max_length=300)
     invitation_letter_organizer_config = models.ForeignKey(
         "InvitationLetterOrganizerConfig",
         on_delete=models.CASCADE,
@@ -169,6 +173,9 @@ class InvitationLetterDocument(OrderedModel, TimeStampedModel):
     dynamic_document = models.JSONField(_("dynamic document"), null=True, blank=True)
     order_with_respect_to = "invitation_letter_organizer_config"
 
+    def __str__(self):
+        return f"Document: {self.name}"
+
 
 class InvitationLetterAsset(TimeStampedModel):
     invitation_letter_organizer_config = models.ForeignKey(
@@ -185,3 +192,6 @@ class InvitationLetterAsset(TimeStampedModel):
         null=True,
         blank=True,
     )
+
+    def __str__(self):
+        return f"Asset: {self.handle}"
