Add many-to-many contacts field to interactions

reupen · reupen · commit 25e003441b55 · 2019-01-24T09:36:19.000Z
This adds a many-to-many contacts field to the interaction model.

When the contact field is set via the API or via the admin site, the value is mirrored to the contacts field.

For now, this field is not exposed via the API or admin as the data in contact has not been fully replicated to contacts.
diff --git a/changelog/interaction/contacts-field.db b/changelog/interaction/contacts-field.db
@@ -0,0 +1 @@
+The table ``interaction_interaction_contacts`` table with columns ``("id" serial NOT NULL PRIMARY KEY, "interaction_id" uuid NOT NULL, "contact_id" uuid NOT NULL)`` was added. This is a many-to-many table linking interactions with contacts. The table had not been fully populated with data yet; continue to use ``interaction_interaction.contact_id`` for the time being.
diff --git a/datahub/cleanup/management/commands/delete_old_records.py b/datahub/cleanup/management/commands/delete_old_records.py
@@ -78,6 +78,7 @@ class Command(BaseCleanupCommand):
                 # projects, OMIS orders or OMIS quotes. We wait for those records to expire
                 # before we delete the related contacts.
                 Contact._meta.get_field('interactions'): (),
+                Contact._meta.get_field('interactions_m2m'): (),
                 Contact._meta.get_field('investment_projects'): (),
                 Contact._meta.get_field('orders'): (),
                 Quote._meta.get_field('accepted_by').remote_field: (),
diff --git a/datahub/cleanup/test/commands/factories.py b/datahub/cleanup/test/commands/factories.py
@@ -1,4 +1,5 @@
 from datahub.core.test.factories import to_many_field
+from datahub.interaction.test.factories import CompanyInteractionFactory
 from datahub.investment.test.factories import InvestmentProjectFactory
 
 
@@ -16,3 +17,19 @@ class ShallowInvestmentProjectFactory(InvestmentProjectFactory):
     def client_contacts(self):
         """No client contacts."""
         return []
+
+
+class CompanyInteractionFactoryWithoutContacts(CompanyInteractionFactory):
+    """
+    Same as CompanyInteractionFactory but with reduced dependencies
+    so that we can test specific references without extra noise.
+
+    TODO: Remove once Interaction.contact has been removed.
+    """
+
+    contact = None
+
+    @to_many_field
+    def contacts(self):
+        """Default to no contacts."""
+        return []
diff --git a/datahub/cleanup/test/commands/test_delete_old_records.py b/datahub/cleanup/test/commands/test_delete_old_records.py
@@ -23,6 +23,7 @@
     ORDER_MODIFIED_ON_CUT_OFF,
 )
 from datahub.cleanup.query_utils import get_relations_to_delete
+from datahub.cleanup.test.commands.factories import CompanyInteractionFactoryWithoutContacts
 from datahub.company.test.factories import (
     CompanyFactory,
     ContactFactory,
@@ -206,7 +207,7 @@
         ],
         'relations': [
             {
-                'factory': CompanyInteractionFactory,
+                'factory': CompanyInteractionFactoryWithoutContacts,
                 'field': 'contact',
                 'expired_objects_kwargs': [],
                 'unexpired_objects_kwargs': [
@@ -216,6 +217,17 @@
                     },
                 ],
             },
+            {
+                'factory': CompanyInteractionFactoryWithoutContacts,
+                'field': 'contacts',
+                'expired_objects_kwargs': [],
+                'unexpired_objects_kwargs': [
+                    {
+                        'created_on': CONTACT_DELETE_BEFORE_DATETIME - relativedelta(days=1),
+                        'modified_on': CONTACT_DELETE_BEFORE_DATETIME - relativedelta(days=1),
+                    },
+                ],
+            },
             {
                 'factory': InvestmentProjectFactory,
                 'field': 'client_contacts',
@@ -253,7 +265,7 @@
     },
     'interaction.Interaction': {
         'factory': CompanyInteractionFactory,
-        'implicitly_deletable_models': set(),
+        'implicitly_deletable_models': {'interaction.Interaction_contacts'},
         'expired_objects_kwargs': [
             {
                 'date': INTERACTION_DELETE_BEFORE_DATETIME - relativedelta(days=1),
diff --git a/datahub/cleanup/test/commands/test_delete_orphans.py b/datahub/cleanup/test/commands/test_delete_orphans.py
@@ -11,7 +11,10 @@
 
 from datahub.cleanup.management.commands import delete_orphans
 from datahub.cleanup.query_utils import get_relations_to_delete
-from datahub.cleanup.test.commands.factories import ShallowInvestmentProjectFactory
+from datahub.cleanup.test.commands.factories import (
+    CompanyInteractionFactoryWithoutContacts,
+    ShallowInvestmentProjectFactory,
+)
 from datahub.company.test.factories import (
     CompanyFactory,
     ContactFactory,
@@ -43,7 +46,8 @@
     'company.Contact': {
         'factory': ContactFactory,
         'dependent_models': (
-            (CompanyInteractionFactory, 'contact'),
+            (CompanyInteractionFactoryWithoutContacts, 'contact'),
+            (CompanyInteractionFactoryWithoutContacts, 'contacts'),
             (OrderFactory, 'contact'),
             (QuoteFactory, 'accepted_by'),
             (InvestmentProjectFactory, 'client_contacts'),
diff --git a/datahub/interaction/admin.py b/datahub/interaction/admin.py
@@ -61,4 +61,18 @@ class InteractionAdmin(BaseModelAdminMixin, VersionAdmin):
         'created_by',
         'modified_on',
         'modified_by',
+        'contacts',
     )
+
+    def save_model(self, request, obj, form, change):
+        """
+        Saves the object, populating contacts from contact.
+
+        TODO: Remove once the migration from contact to contacts is complete.
+        """
+        if 'contact' in form.cleaned_data:
+            contact = form.cleaned_data['contact']
+            contacts = [contact] if contact else []
+            obj.contacts.set(contacts)
+
+        super().save_model(request, obj, form, change)
diff --git a/datahub/interaction/migrations/0041_add_contacts_field.py b/datahub/interaction/migrations/0041_add_contacts_field.py
@@ -0,0 +1,19 @@
+# Generated by Django 2.1.5 on 2019-01-21 15:08
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('company', '0060_trading_names_not_null'),
+        ('interaction', '0040_make_policy_provided_non_nullable'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='interaction',
+            name='contacts',
+            field=models.ManyToManyField(blank=True, related_name='interactions_m2m', to='company.Contact'),
+        ),
+    ]
diff --git a/datahub/interaction/models.py b/datahub/interaction/models.py
@@ -99,13 +99,21 @@ class Interaction(BaseModel):
         null=True,
         on_delete=models.CASCADE,
     )
+    # TODO: contact is being replaced with contacts, and contact will be removed once the
+    # migration to a to-many field is complete
     contact = models.ForeignKey(
         'company.Contact',
         related_name="%(class)ss",  # noqa: Q000
         blank=True,
         null=True,
         on_delete=models.CASCADE,
     )
+    contacts = models.ManyToManyField(
+        'company.Contact',
+        # TODO: change related_name to interactions once this field has fully replaced contact
+        related_name='interactions_m2m',
+        blank=True,
+    )
     event = models.ForeignKey(
         'event.Event',
         related_name="%(class)ss",  # noqa: Q000
diff --git a/datahub/interaction/serializers.py b/datahub/interaction/serializers.py
@@ -91,6 +91,11 @@ def validate(self, data):
         """
         if 'is_event' in data:
             del data['is_event']
+
+        if 'contact' in data:
+            # Note: null contacts are not allowed in the API
+            data['contacts'] = [data['contact']]
+
         return data
 
     class Meta:
diff --git a/datahub/interaction/test/factories.py b/datahub/interaction/test/factories.py
@@ -35,6 +35,15 @@ class InteractionFactoryBase(factory.django.DjangoModelFactory):
     archived_documents_url_path = factory.Faker('uri_path')
     was_policy_feedback_provided = False
 
+    @to_many_field
+    def contacts(self):
+        """
+        Contacts field.
+
+        Defaults to the contact from the contact field.
+        """
+        return [self.contact] if self.contact else []
+
     class Meta:
         model = 'interaction.Interaction'
 
diff --git a/datahub/interaction/test/test_admin.py b/datahub/interaction/test/test_admin.py
@@ -0,0 +1,123 @@
+from uuid import uuid4
+
+from django.contrib.admin.templatetags.admin_urls import admin_urlname
+from django.urls import reverse
+from rest_framework import status
+
+from datahub.company.test.factories import CompanyFactory, ContactFactory
+from datahub.core.admin import get_change_url
+from datahub.core.test_utils import AdminTestMixin, random_obj_for_model
+from datahub.interaction.models import CommunicationChannel, Interaction
+from datahub.interaction.test.factories import CompanyInteractionFactory
+from datahub.metadata.models import Service, Team
+
+
+class TestInteractionAdmin(AdminTestMixin):
+    """
+    Tests for interaction admin.
+
+    TODO: these tests will be removed once the migration from contact to contacts is complete.
+    """
+
+    def test_add(self):
+        """Test that adding an interaction also sets the contacts field."""
+        company = CompanyFactory()
+        contact = ContactFactory()
+        communication_channel = random_obj_for_model(CommunicationChannel)
+
+        url = reverse(admin_urlname(Interaction._meta, 'add'))
+        data = {
+            'id': uuid4(),
+            'kind': Interaction.KINDS.interaction,
+            'communication_channel': communication_channel.pk,
+            'subject': 'whatever',
+            'date_0': '2018-01-01',
+            'date_1': '00:00:00',
+            'dit_adviser': self.user.pk,
+            'company': company.pk,
+            'contact': contact.pk,
+            'service': random_obj_for_model(Service).pk,
+            'dit_team': random_obj_for_model(Team).pk,
+            'was_policy_feedback_provided': False,
+        }
+        response = self.client.post(url, data, follow=True)
+
+        assert response.status_code == status.HTTP_200_OK
+
+        assert Interaction.objects.count() == 1
+        interaction = Interaction.objects.first()
+
+        assert interaction.contact == contact
+        assert list(interaction.contacts.all()) == [contact]
+
+    def test_update_contact_to_non_null(self):
+        """
+        Test that updating an interaction with a non-null contact also sets the contacts
+        field.
+        """
+        interaction = CompanyInteractionFactory(contacts=[])
+        new_contact = ContactFactory(company=interaction.company)
+
+        url = get_change_url(interaction)
+        data = {
+            # Unchanged values
+            'id': interaction.pk,
+            'kind': Interaction.KINDS.interaction,
+            'communication_channel': interaction.communication_channel.pk,
+            'subject': interaction.subject,
+            'date_0': interaction.date.date().isoformat(),
+            'date_1': interaction.date.time().isoformat(),
+            'dit_adviser': interaction.dit_adviser.pk,
+            'company': interaction.company.pk,
+            'service': interaction.service.pk,
+            'dit_team': interaction.dit_team.pk,
+            'was_policy_feedback_provided': interaction.was_policy_feedback_provided,
+            'policy_feedback_notes': interaction.policy_feedback_notes,
+            'policy_areas': [],
+            'policy_issue_types': [],
+            'event': '',
+
+            # Changed values
+            'contact': new_contact.pk,
+        }
+        response = self.client.post(url, data=data, follow=True)
+
+        assert response.status_code == status.HTTP_200_OK
+
+        interaction.refresh_from_db()
+        assert interaction.contact == new_contact
+        assert list(interaction.contacts.all()) == [new_contact]
+
+    def test_update_contact_to_null(self):
+        """Test that updating an interaction with a null contact clears the contacts field."""
+        interaction = CompanyInteractionFactory(contacts=[])
+
+        url = get_change_url(interaction)
+        data = {
+            # Unchanged values
+            'id': interaction.pk,
+            'kind': Interaction.KINDS.interaction,
+            'communication_channel': interaction.communication_channel.pk,
+            'subject': interaction.subject,
+            'date_0': interaction.date.date().isoformat(),
+            'date_1': interaction.date.time().isoformat(),
+            'dit_adviser': interaction.dit_adviser.pk,
+            'company': interaction.company.pk,
+            'service': interaction.service.pk,
+            'dit_team': interaction.dit_team.pk,
+            'was_policy_feedback_provided': interaction.was_policy_feedback_provided,
+            'policy_feedback_notes': interaction.policy_feedback_notes,
+            'policy_areas': [],
+            'policy_issue_types': [],
+            'event': '',
+
+            # Changed values
+            'contact': '',
+        }
+        response = self.client.post(url, data=data, follow=True)
+
+        assert response.status_code == status.HTTP_200_OK
+
+        interaction.refresh_from_db()
+        assert interaction.contact is None
+        assert interaction.contacts.count() == 0
diff --git a/datahub/interaction/test/views/test_common.py b/datahub/interaction/test/views/test_common.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+The table ``interaction_interaction_contacts`` table with columns ``("id" serial NOT NULL PRIMARY KEY, "interaction_id" uuid NOT NULL, "contact_id" uuid NOT NULL)`` was added. This is a many-to-many table linking interactions with contacts. The table had not been fully populated with data yet; continue to use ``interaction_interaction.contact_id`` for the time being.