[OSDEV-1229] Create moderation events table

doc/release/RELEASE-NOTES.md

@@ -7,7 +7,14 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## Introduction
 * Product name: Open Supply Hub
-* Release date: November 2, 2024
+* Release date: November 02, 2024
+
+### Database changes
+#### Migrations:
+* 0158_create_moderation_events_table.py - This migration creates api_moderationevent table for Moderation Queue.
+
+#### Scheme changes
+* [OSDEV-1229](https://opensupplyhub.atlassian.net/browse/OSDEV-1229) - Created Moderation Events Postgres table to track moderation events in the database.
 
 ### Database changes
 #### Migrations:
@@ -30,6 +37,8 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 * *Describe what's new here. The changes that can impact user experience should be listed in this section.*
 
 ### Release instructions:
+* Ensure that the following commands are included in the `post_deployment` command:
+    * `migrate`
 * Run `Deploy to AWS` pipeline for an existing environment with the flag clear OpenSearch set to true - to let the tokenizer parse full text into words with new configurations.
 
 

src/django/api/migrations/0158_create_moderation_event_table.py

@@ -0,0 +1,42 @@
+# Generated by Django 3.2.17 on 2024-10-22 11:43
+
+import django.contrib.postgres.indexes
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0157_delete_endpoint_switcher_for_list_uploads'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ModerationEvent',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('uuid', models.UUIDField(db_index=True, default=uuid.uuid4, editable=False, help_text='Unique identifier to make moderation event table more reusable across the app.', unique=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True, help_text='Date when the moderation queue entry was created.')),
+                ('updated_at', models.DateTimeField(auto_now=True, db_index=True, help_text='Date when the moderation queue entry was last updated.')),
+                ('status_change_date', models.DateTimeField(blank=True, help_text='Date when the moderation decision was made.', null=True)),
+                ('request_type', models.CharField(choices=[('CREATE', 'Create'), ('UPDATE', 'Update'), ('CLAIM', 'Claim')], help_text='Type of moderation record.', max_length=6)),
+                ('raw_data', models.JSONField(default=dict, help_text='Key-value pairs of the non-parsed row and header for the moderation data.')),
+                ('cleaned_data', models.JSONField(default=dict, help_text='Key-value pairs of the parsed row and header for the moderation data.')),
+                ('geocode_result', models.JSONField(default=dict, help_text='Result of the geocode operation.')),
+                ('status', models.CharField(choices=[('PENDING', 'Pending'), ('RESOLVED', 'Resolved')], default='PENDING', help_text='Moderation status of the production location.', max_length=8)),
+                ('source', models.CharField(blank=True, choices=[('API', 'API'), ('SLC', 'SLC')], default='', help_text='Source type of production location. If request_type is CLAIM, no source type.', max_length=3)),
+            ],
+        ),
+        migrations.AddField(
+            model_name='moderationevent',
+            name='claim',
+            field=models.OneToOneField(help_text='Linked claim id for this production location.', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='moderation_event', to='api.facilityclaim'),
+        ),
+        migrations.AddField(
+            model_name='moderationevent',
+            name='contributor',
+            field=models.ForeignKey(help_text='Linked contributor responsible for this moderation event.', null=True, on_delete=django.db.models.deletion.PROTECT, related_name='moderation_events', to='api.contributor'),
+        ),
+    ]

src/django/api/models/__init__.py

@@ -1,77 +1,78 @@
 # flake8: noqa: F401
 
-from .api.api_block import (
+from api.models.api.api_block import (
   ApiBlock,
   HistoricalApiBlock,
 )
-from .api.api_limit import (
+from api.models.api.api_limit import (
   ApiLimit,
   HistoricalApiLimit,
 )
-from .contributor.contributor import (
+from api.models.contributor.contributor import (
   Contributor,
   HistoricalContributor
 )
-from .contributor.contributor_manager import ContributorManager
-from .contributor.contributor_notifications import (
+from api.models.contributor.contributor_manager import ContributorManager
+from api.models.contributor.contributor_notifications import (
   ContributorNotifications,
   HistoricalContributorNotifications
 )
-from .facility.facility import (
+from api.models.facility.facility import (
   Facility,
   HistoricalFacility,
 )
-from .facility.facility_activity_report import (
+from api.models.facility.facility_activity_report import (
   FacilityActivityReport,
   HistoricalFacilityActivityReport,
 )
-from .facility.facility_alias import (
+from api.models.facility.facility_alias import (
   FacilityAlias,
   HistoricalFacilityAlias,
 )
-from .facility.facility_claim import (
+from api.models.facility.facility_claim import (
   FacilityClaim,
   HistoricalFacilityClaim,
 )
-from .facility.facility_claim_review_note import (
+from api.models.facility.facility_claim_review_note import (
   FacilityClaimReviewNote,
   HistoricalFacilityClaimReviewNote,
 )
-from .facility.facility_claim_attachments import (
+from api.models.facility.facility_claim_attachments import (
     FacilityClaimAttachments
 )
-from .facility.facility_list import FacilityList
-from .facility.facility_list_item import FacilityListItem
-from .facility.facility_list_item_temp import FacilityListItemTemp
-from .facility.facility_location import FacilityLocation
+from api.models.facility.facility_list import FacilityList
+from api.models.facility.facility_list_item import FacilityListItem
+from api.models.facility.facility_list_item_temp import FacilityListItemTemp
+from api.models.facility.facility_location import FacilityLocation
 
-from .facility.facility_match import (
+from api.models.facility.facility_match import (
   FacilityMatch,
   HistoricalFacilityMatch,
 )
-from .facility.facility_match_temp import (
+from api.models.facility.facility_match_temp import (
     FacilityMatchTemp,
     HistoricalFacilityMatchTemp,
 )
-from .download_log import DownloadLog
-from .embed_config import EmbedConfig
-from .embed_field import EmbedField
-from .event import Event
-from .extended_field import (
+from api.models.download_log import DownloadLog
+from api.models.embed_config import EmbedConfig
+from api.models.embed_field import EmbedField
+from api.models.event import Event
+from api.models.extended_field import (
   ExtendedField,
   HistoricalExtendedField
 )
-from .nonstandart_field import NonstandardField
-from .product_type import ProductType
-from .production_type import ProductionType
-from .request_log import RequestLog
-from .sector import Sector
-from .source import Source
-from .user import (
+from api.models.nonstandart_field import NonstandardField
+from api.models.product_type import ProductType
+from api.models.production_type import ProductionType
+from api.models.request_log import RequestLog
+from api.models.sector import Sector
+from api.models.source import Source
+from api.models.user import (
   EmailAsUsernameUserManager,
   get_default_burst_rate,
   get_default_sustained_rate,
   get_default_data_upload_rate,
   User,
 )
-from .version import Version
+from api.models.version import Version
+from api.models.moderation_event import ModerationEvent

src/django/api/models/moderation_event.py

@@ -0,0 +1,128 @@
+import uuid
+from django.db import models
+from api.models.contributor.contributor import Contributor
+from api.models.facility.facility_claim import FacilityClaim
+
+
+class ModerationEvent(models.Model):
+    '''
+    Data that is needed for moderation queue.
+    '''
+    class RequestType(models.TextChoices):
+        CREATE = 'CREATE', 'Create'
+        UPDATE = 'UPDATE', 'Update'
+        CLAIM = 'CLAIM', 'Claim'
+
+    class Status(models.TextChoices):
+        PENDING = 'PENDING', 'Pending'
+        RESOLVED = 'RESOLVED', 'Resolved'
+
+    class Source(models.TextChoices):
+        API = 'API', 'API'
+        SLC = 'SLC', 'SLC'
+
+    uuid = models.UUIDField(
+        default=uuid.uuid4,
+        editable=False,
+        unique=True,
+        db_index=True,
+        help_text=(
+            'Unique identifier to make moderation '
+            'event table more reusable across the app.'
+        )
+    )
+
+    created_at = models.DateTimeField(
+        auto_now_add=True,
+        help_text='Date when the moderation queue entry was created.'
+    )
+
+    updated_at = models.DateTimeField(
+        auto_now=True,
+        help_text='Date when the moderation queue entry was last updated.',
+        db_index=True
+    )
+
+    status_change_date = models.DateTimeField(
+        blank=True,
+        null=True,
+        help_text='Date when the moderation decision was made.'
+    )
+
+    contributor = models.ForeignKey(
+        Contributor,
+        on_delete=models.PROTECT,
+        null=True,
+        related_name='moderation_events',
+        help_text='Linked contributor responsible for this moderation event.'
+    )
+
+    claim = models.OneToOneField(
+        FacilityClaim,
+        on_delete=models.SET_NULL,
+        null=True,
+        related_name='moderation_event',
+        help_text='Linked claim id for this production location.'
+    )
+
+    request_type = models.CharField(
+        max_length=6,
+        null=False,
+        choices=RequestType.choices,
+        help_text='Type of moderation record.'
+    )
+
+    raw_data = models.JSONField(
+        null=False,
+        blank=False,
+        default=dict,
+        help_text=(
+            'Key-value pairs of the non-parsed row and '
+            'header for the moderation data.'
+        )
+    )
+
+    cleaned_data = models.JSONField(
+        null=False,
+        blank=False,
+        default=dict,
+        help_text=(
+            'Key-value pairs of the parsed row and '
+            'header for the moderation data.'
+        )
+    )
+
+    geocode_result = models.JSONField(
+        null=False,
+        blank=False,
+        default=dict,
+        help_text=(
+            'Result of the geocode operation.'
+        )
+    )
+
+    status = models.CharField(
+        max_length=8,
+        choices=Status.choices,
+        default=Status.PENDING,
+        null=False,
+        help_text='Moderation status of the production location.'
+    )
+
+    source = models.CharField(
+        max_length=3,
+        choices=Source.choices,
+        blank=True,
+        default='',
+        help_text=(
+            'Source type of production location.'
+            ' If request_type is CLAIM, no source type.'
+        )
+    )
+
+    def __str__(self):
+        return (
+            f'ModerationEvent entry {self.uuid} '
+            f'with request type {self.request_type} '
+            f'and status {self.status}'
+        )