Report issues with metadata

.env.tpl

@@ -18,3 +18,13 @@ AZURE_AUTHORITY=op://Data-Catalogue/Find-Moj-Data/${ENV}/Azure-Authority
 
 # Sentry Variables
 SENTRY_DSN__WORKAROUND=op://Data-Catalogue/Find-Moj-Data/${ENV}/Sentry-Dsn
+
+# Notify API Service
+NOTIFY_ENABLED=op://Data-Catalogue/Find-Moj-Data/${ENV}/notify-enabled
+NOTIFY_API_KEY=op://Data-Catalogue/Find-Moj-Data/${ENV}/notify-api-key #pragma: allowlist secret
+NOTIFY_DATA_OWNER_TEMPLATE_ID=op://Data-Catalogue/Find-Moj-Data/${ENV}/notify-data-owner-template-id
+NOTIFY_SENDER_TEMPLATE_ID=op://Data-Catalogue/Find-Moj-Data/${ENV}/notify-sender-template-id
+NOTIFY_DATA_CATALOGUE_TEMPLATE_ID=op://Data-Catalogue/Find-Moj-Data/${ENV}/notify-data-catalogue-template-id
+
+# Data Catalogue Email
+DATA_CATALOGUE_EMAIL=op://Data-Catalogue/Find-Moj-Data/${ENV}/data-catalogue-email

core/context_processors.py

@@ -13,3 +13,7 @@ def analytics(request) -> dict[str, Any]:
         "ANALYTICS_ID": settings.ANALYTICS_ID,
         "GIT_REF": settings.GIT_REF,
     }
+
+
+def notify_enabled(request) -> dict[str, Any]:
+    return {"NOTIFY_ENABLED": settings.NOTIFY_ENABLED}

core/settings.py

@@ -86,6 +86,7 @@
                 "django.contrib.messages.context_processors.messages",
                 "core.context_processors.env",
                 "core.context_processors.analytics",
+                "core.context_processors.notify_enabled",
             ],
         },
     },
@@ -284,3 +285,13 @@
 SESSION_COOKIE_SECURE = True
 
 GIT_REF = os.environ.get("GIT_REF", "unknown")
+
+# Notifify API Credentials
+NOTIFY_ENABLED = os.environ.get("NOTIFY_ENABLED", "false") in TRUTHY_VALUES
+NOTIFY_API_KEY = os.environ.get("NOTIFY_API_KEY")
+NOTIFY_DATA_OWNER_TEMPLATE_ID = os.environ.get("NOTIFY_DATA_OWNER_TEMPLATE_ID")
+NOTIFY_SENDER_TEMPLATE_ID = os.environ.get("NOTIFY_SENDER_TEMPLATE_ID")
+NOTIFY_DATA_CATALOGUE_TEMPLATE_ID = os.environ.get("NOTIFY_DATA_CATALOGUE_TEMPLATE_ID")
+
+# Data Catalogue Email
+DATA_CATALOGUE_EMAIL = os.environ.get("DATA_CATALOGUE_EMAIL")

feedback/forms.py

@@ -1,7 +1,7 @@
-from django.forms import ModelForm
-from django.forms.widgets import RadioSelect
+from django import forms
+from django.forms.widgets import RadioSelect, Textarea, TextInput
 
-from .models import Feedback
+from .models import Feedback, Issue
 
 
 def formfield(field, **kwargs):
@@ -15,11 +15,41 @@ def formfield(field, **kwargs):
     return field.formfield(initial=None, **kwargs)
 
 
-class FeedbackForm(ModelForm):
+class FeedbackForm(forms.ModelForm):
     class Meta:
         model = Feedback
         fields = ["satisfaction_rating", "how_can_we_improve"]
         widgets = {
             "satisfaction_rating": RadioSelect(attrs={"class": "govuk-radios__input"})
         }
         formfield_callback = formfield
+
+
+class IssueForm(forms.ModelForm):
+    class Meta:
+        model = Issue
+        fields = [
+            "reason",
+            "additional_info",
+            "user_email",
+        ]
+        widgets = {
+            "reason": RadioSelect(attrs={"class": "govuk-radios__input"}),
+            "additional_info": Textarea(
+                attrs={
+                    "class": "govuk-textarea",
+                    "rows": "5",
+                    "aria-describedby": "more-detail-hint",
+                }
+            ),
+            "user_email": TextInput(
+                attrs={
+                    "class": "govuk-input",
+                    "type": "email",
+                    "spellcheck": "false",
+                    "aria-describedby": "email-hint",
+                    "autocomplete": "email",
+                }
+            ),
+        }
+        formfield_callback = formfield

feedback/migrations/0003_reportissue.py

@@ -0,0 +1,51 @@
+# Generated by Django 5.1.2 on 2024-10-16 12:30
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0002_alter_feedback_how_can_we_improve"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ReportIssue",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "reason",
+                    models.CharField(
+                        choices=[
+                            ("Broken link", "Broken Link"),
+                            ("Incorrect owner", "Incorrect Owner"),
+                            ("Outdated contact", "Outdated Contact"),
+                            ("Other", "Other"),
+                        ],
+                        max_length=50,
+                    ),
+                ),
+                ("data_asset_name", models.CharField(max_length=250)),
+                ("data_asset_url", models.CharField(max_length=250)),
+                (
+                    "data_asset_owner_email",
+                    models.CharField(
+                        blank=True,
+                        max_length=250,
+                        null=True,
+                        validators=[django.core.validators.EmailValidator()],
+                    ),
+                ),
+            ],
+        ),
+    ]

feedback/migrations/0004_reportissue_additional_info_alter_reportissue_reason.py

@@ -0,0 +1,32 @@
+# Generated by Django 5.1.2 on 2024-10-16 13:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0003_reportissue"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="reportissue",
+            name="additional_info",
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="reason",
+            field=models.CharField(
+                choices=[
+                    ("Broken link", "Broken Link"),
+                    ("Incorrect owner", "Incorrect Owner"),
+                    ("Outdated contact", "Outdated Contact"),
+                    ("Other", "Other"),
+                ],
+                max_length=50,
+                verbose_name="Reason",
+            ),
+        ),
+    ]

feedback/migrations/0005_reportissue_user_email_and_more.py

@@ -0,0 +1,31 @@
+# Generated by Django 5.1.2 on 2024-10-16 13:28
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0004_reportissue_additional_info_alter_reportissue_reason"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="reportissue",
+            name="user_email",
+            field=models.CharField(
+                blank=True,
+                max_length=250,
+                null=True,
+                validators=[django.core.validators.EmailValidator()],
+            ),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="additional_info",
+            field=models.TextField(
+                blank=True, null=True, verbose_name="Can you provide more detail?"
+            ),
+        ),
+    ]

feedback/migrations/0006_rename_data_asset_owner_email_reportissue_data_owner_email_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.1.2 on 2024-10-16 13:47
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0005_reportissue_user_email_and_more"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="reportissue",
+            old_name="data_asset_owner_email",
+            new_name="data_owner_email",
+        ),
+        migrations.RenameField(
+            model_name="reportissue",
+            old_name="data_asset_name",
+            new_name="entity_name",
+        ),
+        migrations.RenameField(
+            model_name="reportissue",
+            old_name="data_asset_url",
+            new_name="entity_url",
+        ),
+    ]

feedback/migrations/0007_reportissue_created_reportissue_modified_and_more.py

@@ -0,0 +1,43 @@
+# Generated by Django 5.1.2 on 2024-10-16 15:29
+
+import uuid
+
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "feedback",
+            "0006_rename_data_asset_owner_email_reportissue_data_owner_email_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="reportissue",
+            name="created",
+            field=models.DateTimeField(
+                auto_now_add=True, default=django.utils.timezone.now
+            ),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name="reportissue",
+            name="modified",
+            field=models.DateTimeField(auto_now=True),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="id",
+            field=models.UUIDField(
+                default=uuid.uuid4,
+                editable=False,
+                primary_key=True,
+                serialize=False,
+                unique=True,
+            ),
+        ),
+    ]

feedback/migrations/0008_alter_reportissue_additional_info_and_more.py

@@ -0,0 +1,53 @@
+# Generated by Django 5.1.2 on 2024-10-16 19:59
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0007_reportissue_created_reportissue_modified_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="reportissue",
+            name="additional_info",
+            field=models.TextField(
+                blank=True, verbose_name="Can you provide more detail?"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="data_owner_email",
+            field=models.CharField(
+                max_length=250, validators=[django.core.validators.EmailValidator()]
+            ),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="entity_name",
+            field=models.CharField(
+                max_length=250,
+                validators=[django.core.validators.MinLengthValidator(1)],
+            ),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="entity_url",
+            field=models.CharField(
+                max_length=250,
+                validators=[django.core.validators.MinLengthValidator(1)],
+            ),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="user_email",
+            field=models.CharField(
+                blank=True,
+                max_length=250,
+                validators=[django.core.validators.EmailValidator()],
+            ),
+        ),
+    ]

feedback/migrations/0009_alter_reportissue_additional_info_and_more.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.1.2 on 2024-10-18 14:15
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0008_alter_reportissue_additional_info_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="reportissue",
+            name="additional_info",
+            field=models.TextField(
+                validators=[django.core.validators.MinLengthValidator(10)],
+                verbose_name="Can you provide more detail?",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="data_owner_email",
+            field=models.CharField(max_length=250),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="entity_name",
+            field=models.CharField(max_length=250),
+        ),
+        migrations.AlterField(
+            model_name="reportissue",
+            name="entity_url",
+            field=models.CharField(max_length=250),
+        ),
+    ]