Merge pull request #232 from monzo/store-deleted

Store whether the user has been deleted

response/core/models/user_external.py

@@ -20,6 +20,7 @@ class Meta:
     display_name = models.CharField(max_length=50, blank=False, null=False)
     full_name = models.CharField(max_length=50, blank=True, null=True)
     email = models.CharField(max_length=100, blank=True, null=True)
+    deleted = models.BooleanField(default=False)
 
     objects = ExternalUserManager()
 

response/core/serializers.py

@@ -11,7 +11,14 @@
 class ExternalUserSerializer(serializers.ModelSerializer):
     class Meta:
         model = ExternalUser
-        fields = ("app_id", "external_id", "display_name", "full_name", "email")
+        fields = (
+            "app_id",
+            "external_id",
+            "display_name",
+            "full_name",
+            "email",
+            "deleted",
+        )
 
 
 class TimelineEventSerializer(serializers.ModelSerializer):

response/migrations/0017_externaluser_deleted.py

@@ -0,0 +1,16 @@
+# Generated by Django 2.2.16 on 2020-10-07 13:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("response", "0016_actions_auto_created_date")]
+
+    operations = [
+        migrations.AddField(
+            model_name="externaluser",
+            name="deleted",
+            field=models.BooleanField(default=False),
+        )
+    ]

response/slack/cache.py

@@ -28,6 +28,7 @@ def update_user_cache(exclude_bots=False):
                         or user["name"],
                         "full_name": user["profile"]["real_name"] or user["name"],
                         "email": user["profile"].get("email", None),
+                        "deleted": user["deleted"],
                     },
                 )
         cursor = response["response_metadata"].get("next_cursor")
@@ -51,6 +52,7 @@ def get_user_profile(external_id):
             "name": external_user.display_name,
             "fullname": external_user.full_name,
             "email": external_user.email,
+            "deleted": external_user.deleted,
         }
     except ExternalUser.DoesNotExist:
         # profile from slack
@@ -67,6 +69,7 @@ def get_user_profile(external_id):
                 "display_name": user_profile["name"],
                 "full_name": user_profile["fullname"],
                 "email": user_profile["email"],
+                "deleted": user_profile["deleted"],
             },
         )
 
@@ -92,6 +95,7 @@ def get_user_profile_by_email(email):
             "name": external_user.display_name,
             "fullname": external_user.full_name,
             "email": external_user.email,
+            "deleted": external_user.deleted,
         }
     except ExternalUser.DoesNotExist:
         # profile from slack
@@ -110,6 +114,7 @@ def get_user_profile_by_email(email):
                 "display_name": user_profile["name"],
                 "full_name": user_profile["fullname"],
                 "email": user_profile["email"],
+                "deleted": user_profile["deleted"],
             },
         )
 

response/slack/client.py

@@ -248,6 +248,7 @@ def get_user_profile(self, user_id):
             "name": response["user"]["name"],
             "fullname": response["user"]["profile"]["real_name"],
             "email": response["user"]["profile"].get("email", None),
+            "deleted": response["user"]["deleted"],
         }
 
     def get_user_profile_by_email(self, email):
@@ -261,6 +262,7 @@ def get_user_profile_by_email(self, email):
             "name": response["user"]["name"],
             "fullname": response["user"]["profile"]["real_name"],
             "email": email,
+            "deleted": response["user"]["deleted"],
         }
 
     def rename_channel(self, channel_id, new_name):

tests/slack/slack_payloads.py

@@ -5,7 +5,7 @@
             "id": "W012A3CDE",
             "team_id": "T012AB3C4",
             "name": "spengler",
-            "deleted": False,
+            "deleted": True,
             "color": "9f69e7",
             "real_name": "spengler",
             "tz": "America/Los_Angeles",

tests/slack/test_cache.py

@@ -21,6 +21,16 @@ def test_update_cache_from_empty(mock_slack):
     update_user_cache()
 
     assert len(ExternalUser.objects.all()) == 2
+    cache_user1 = ExternalUser.objects.get(external_id="W012A3CDE")
+    assert cache_user1.display_name == "spengler"
+    assert cache_user1.full_name == "Egon Spengler"
+    assert cache_user1.email == "[email protected]"
+    assert cache_user1.deleted
+    cache_user2 = ExternalUser.objects.get(external_id="U12345678")
+    assert cache_user2.display_name == "Glinda the Fairly Good"
+    assert cache_user2.full_name == "Glinda Southgood"
+    assert cache_user2.email == "[email protected]"
+    assert not cache_user2.deleted
 
 
 @pytest.mark.django_db
@@ -77,6 +87,7 @@ def test_get_user_profile_not_in_cache(mock_slack):
         "name": "spengler",
         "fullname": "Egon Spengler",
         "email": "[email protected]",
+        "deleted": True,
     }
 
     # check cache is empty at start
@@ -97,17 +108,18 @@ def test_get_user_profile_not_in_cache(mock_slack):
     assert cache_user.display_name == "spengler"
     assert cache_user.full_name == "Egon Spengler"
     assert cache_user.email == "[email protected]"
+    assert cache_user.deleted
 
 
 @pytest.mark.django_db
 def test_get_user_profile_in_cache(mock_slack):
-
     # create cache entry for user
     slack_user = ExternalUser(
         external_id="U12345678",
         display_name="spengler",
         full_name="Egon Spengler",
         email="[email protected]",
+        deleted=True,
     )
     slack_user.save()
     assert len(ExternalUser.objects.all()) == 1
@@ -121,6 +133,7 @@ def test_get_user_profile_in_cache(mock_slack):
     assert user["name"] == "spengler"
     assert user["fullname"] == "Egon Spengler"
     assert user["email"] == "[email protected]"
+    assert user["deleted"]
 
     # check cache is unchanged
     assert len(ExternalUser.objects.all()) == 1
@@ -133,6 +146,7 @@ def test_get_user_profile_by_email_not_in_cache(mock_slack):
         "name": "spengler",
         "fullname": "Egon Spengler",
         "email": "[email protected]",
+        "deleted": True,
     }
 
     # check cache is empty at start
@@ -153,6 +167,7 @@ def test_get_user_profile_by_email_not_in_cache(mock_slack):
     assert cache_user.display_name == "spengler"
     assert cache_user.full_name == "Egon Spengler"
     assert cache_user.email == "[email protected]"
+    assert cache_user.deleted
 
 
 @pytest.mark.django_db
@@ -163,6 +178,7 @@ def test_get_user_profile_by_email_in_cache(mock_slack):
         display_name="spengler",
         full_name="Egon Spengler",
         email="[email protected]",
+        deleted=True,
     )
     slack_user.save()
     assert len(ExternalUser.objects.all()) == 1
@@ -176,6 +192,7 @@ def test_get_user_profile_by_email_in_cache(mock_slack):
     assert user["name"] == "spengler"
     assert user["fullname"] == "Egon Spengler"
     assert user["email"] == "[email protected]"
+    assert user["deleted"]
 
     # check cache is unchanged
     assert len(ExternalUser.objects.all()) == 1