From 961bceb64ee85a2feafdd5e2f0e7660b080d92fc Mon Sep 17 00:00:00 2001
From: Sabrina Demagny <sabrina.demagny@gmail.com>
Date: Mon, 10 Feb 2025 12:21:58 +0100
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8(domains)=20store=20last=20check=20dom?=
 =?UTF-8?q?ain=20results?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Store results of last dimail check on a domain.
---
 CHANGELOG.md                                  |   1 +
 .../locale/fr_FR/LC_MESSAGES/django.mo        | Bin 12468 -> 12680 bytes
 .../locale/fr_FR/LC_MESSAGES/django.po        |  26 ++++++----
 .../0019_maildomain_last_check_details.py     |  18 +++++++
 src/backend/mailbox_manager/models.py         |   6 +++
 .../tests/test_utils_dimail_client.py         |  45 ++++++++++--------
 src/backend/mailbox_manager/utils/dimail.py   |  10 ++++
 7 files changed, 78 insertions(+), 28 deletions(-)
 create mode 100644 src/backend/mailbox_manager/migrations/0019_maildomain_last_check_details.py

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 000d325..9aa6329 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to
 
 ### Added
 
+- ✨(domains) store last health check details on MailDomain
 - ✨(domains) add support email field on domain
 
 ## [1.11.0] - 2025-02-07
diff --git a/src/backend/locale/fr_FR/LC_MESSAGES/django.mo b/src/backend/locale/fr_FR/LC_MESSAGES/django.mo
index 6cbddccbb07f9a30740ca82c1405282805508dcb..034144f9becebe4ad4a8f8c3aa82564ec6ab42a6 100644
GIT binary patch
delta 3002
zcma*oe@xVM9LMnwh=C^{NB9Fo`4Xc1QcwX?K@>C;k&~a1DRmyFAm^dnsiEj8ZPZ*+
zn@Ou>!(ubr+HyL!+MF)7mVdalrTt;)YBBz3bJ=oB{?VSV`yOreSD)Sc`}lmnoSz@>
z&-;5`b-(Ee-A|4=XK4LII#Cc~%;#7Z$A$LL!87~=i*VsgV@lD5vv2?ta0oZx2xj2~
z&O=AMF&1WF8E(X4JcWEhW|Zq19*m*pe1g>&%cx7yg_`I%#^RZX=Wqx2=dl?d<1<*7
zXn(I6Z*ad0^?V_NJd4>l9am!_^P37fd`ume1=xnE*oW(I2pQYlL1o}q)Icdo_VXMh
zX{Hp}v{{Sn!BnFb+=Mf5Cu$*kFd6sbF6K8U>7?O(oR5>(g0r3WN`0t-dQcM_MJ;Fm
zUHC34<>Od|ag5%GwWy5@qf-ABa*F0J)OgYCBD9T;gN}CEiuw2+&c!j*&VEETZGJ}9
zW*(w;7?ol#BoP_Yq$7Vag{Tx);R@V>T3{cl#)eTxel3Ok>kE&0prXp3P5N**R^vyQ
zhZFc5I_KC6Dn=F8YFvd4sGXihWpV_S>g%Y5e}gCR2mAz^*_|>mIhXuvpcpR8Z~+!z
zEvmSBaS`4|Eo>4OVhOWpCrzkS9z^ZD7gfY(P!kNHGI{}v@D^%ePf$lWJ;ZW#mQGZW
zWMDMrq6R8JrM3h$;AYg3G@?@6iaLrm)Hq$JO!Xp3H6Nmm@-k}To2VoF4k;HC`h|`L
z{u8I+lgNEEm8km!)PzpdgmZ8>irr%&_t!|nN_>Eon8_=|8)w=h25>v~{aA+IqcWUC
z8aeuqDW}uGg9BKPW2lwS&M>A1^H8ZegspfAHQ`;<P7*D9VHv2S$i@IJMK4}JWi~d`
z)`{cX&kx^+=#eju!#Gd_EJ6)jfJ#w0@-Z$hs^T7W;Seh26R0A7gsOohe2IEBYf+i2
zkKDH)^=Evj4ZV&Dn*VJ&I-B#z$Bc04!*6jpZdznda0K1le}<YkKHEOJG}M6EsEsVg
z4%~`-%vCNs@GdHYC5u@k4r1tKI-_(nU@}jY0SmpDgPU*=m*Q=-FgnLxa2D#Q@=!aj
zKxM2MRkV9iXMGg)?=NC3-oZ+|m&5sU493c}2d>2R+<Q<Hk6<<a7J0rRk5`lX0ICLV
zpkCWYs0?J~+rJlu*v$P7)c3x?VjM>;AeB{Vp_v8be~`{f9(;*kqcYLQaw%wY8nu9n
zxEg=Q!<fsg)TtT9dc2Mtzj5+Ps1}M*6YWL4e%%;{Z{Q4k2l*%FgAko{bZ$nz5LaZc
z%!vs+&%&9wJYqSjR<<CgX11dPkKi=y$LTnL@%R>MocB=~xQJTlPsneX2|cBw0q0R^
zs?H45ic3)|twRmmiix;0a^HnoST|~-V;F@D7oJFkR!gXnG_#*jv8zt{iLC@pkC=q;
z5L*bwF-M7RqKVi>DD}O>s|3X#u5JjoY_23Pd`!oY-=%Qd&Q(RI<4{{=WA>sJ?jmY5
zzusB3MnXGOYbW**FA&t0sUVc*orGQ`Wkdz0wuDfTsjVS;h%VjyrzyK?2ME2!YPs6~
zL1K^YXwMUe2<kB0k|J8Df~zESZZ8r+Vm+~$&=IKVtx-LxxYYQyH9kUT9w4%a6NK6;
zgy#RJsY2Cs?rRCX0jh<m_EMyy%FZBKh%};s@Dfu^zbX0wJ2~|LdF8`RwRVKaCn(I2
zd5um9v6x69%7}78RUA#I={I5n;nWSSjo3wW5*rCWQAMcL6SKlS{;$ANVmEP&h#{uh
z;c$n8Og($c;W_)%k)G;v2ZC0I*X;{-Se_2Ar^{;h2Hl;$z?Ee)FDE+n*MC30mwGq4
zve|ES@80JPS~ZQXI?L1T4|@G>f6(%I16KRkrSJd@Wcl1&d;FbapZ0jI!(*3vI`?#X
X+`-On|CQ172g!^7=XXCYOpf{+hK?+L

delta 2815
zcmZA3drXye9LMo5a#aiv1Qj$1<qm<DFfUxf3xSd%VTBPPm#9!n3<!b4i~_e(R=I4o
zrqD(=tUN7?t;=eVYuzkuu1#9xAGv9BrK8zky+7wU_(#8;@ALXS&+$CJ-|zeTJ`eU(
ze^BKb4fi{2v`%8a!q03_263SMFvBbjPh%!dVkl+=o85%Dcn22aB0Pk1(T%bA4X(k<
zxExbvn(?tp4y(*u)<8#N4PXJjhw1naYM=y03B)X~Iatp51}wv47=Yv6?<etd&I3Z6
z>tA66=ii|}jv*iWgF`6e+c=#CTnJ>ec^Hp5n2X%YI#4Tr7ImXfyw^`7$+BOO#n}a9
z&UOVg;R&3M{$b8ULNT24D6GI_jAnf6rW1pGxD7u=%`|eBbE6p40E<u)%D~N-jY|1*
zxE9~XQoM#*NFk#s_0`C(*-_NQ-o|2dqf0CGVOgn|hjXw2wX!Z`5q1EXlf8^u;ajMQ
zoJ8(n!^p?ZanQss;ZpnyHNp7VPHhz;dv0~8?~lzU|5<d-aA7qDM>;i7fGM0G!Z;j4
zP3SzTxW;e={)<}avM5rC#i&}SM@@V;cAyLUaT1k@K31vw49+3{x6&EmLK<E}6;~YJ
zF2;7$#QN}N97R1P6R1>1GrCqDhbrPM)Bw4tj22-gHlZdqfZEFAs0<Fd=%`3e;WYda
zb)&PW8;zn?ei4=0KT%t76?Fq2maPnhB1yER$QrBwHDD!b>*|oQux8YK51=o)Ui4l#
z;=Rz18gKwL;5&HK$Ls`Va9+ytm*G>W$LOTj5!}N0SzLn&JW|SNHEOSWaVvg_B^X6I
znXt?1=@fCH9hI6>crTto4V1pnSwR(QLVHlDZ^1_F#9F+H%4B)0V+~&5e3$pU^cJU9
zDp0>~#xOnqE;>q0FDjLNsHz>t&3F-&>Xm${l@y@%ycMZGJBZ5I>)!J>kvg-_Pz(AQ
z_4_f@mRv#Ie;nHw-(omhf=5sTe2rB&f%;+PVrS2GqHfrNY`=A3J-&wV7|5X<(@`1h
z!9@HGx8w8#=YF-Q3^byvmd-vp>-7&Y9TWLgES6yaHld2E9kt@;Q5ky!!*K|;*WaRk
ze;orcDakA!Gm#`(BgW!k%)<|p$iD_2=RyHyCp%v}jhi?hLDfJ+iu0Hjpfb>ed~835
zG8{zxJKt32kIV|x1R78i-HQkD8T=R{nXNMWeH!_vVC_5?G=b~567yL`6Sg6BXn$h~
zhV!yu+pGq)Ro$q8hER{)7Z`-Upo;N#<YSjP<luZBA$`9cHL)5O9nGW(gR#qNFDmt~
z;tcFZUp$WfcmikQN2uQq<8u57HNha>I=rJS6?LC=sG{76n&=MH1YNCkbmJ}z!5;7V
zOQ;FGf*NQ5eUSTmQhg6@B-BWnH4yED>ZFq>BBoj~ogKuT1h=skVi!@W=YJEO+lgkP
zlA!4AA!4dg+@2Kbd>_Gk$kR4+R0@|kr=Gtf>edm;*j+>+p#oLgN+?rm)x^WZdOiQi
zbhI~0haQvr2xa7MLM?&NUaP4#9wQ#n$^V+347J_FgX++zYfsZtrnZ4-B&b7A3)S<l
zwvgb>==rad_GcThhsY&VnA!@pbwoCit`nMy_fbNR*W-ltzKu|Oz~RPGg{r0kTt&nX
z`pbBu>7}8jf>G7$(V9n;5H-Y9(@Un6=$N{IiQc}7^9dq_P~GS$Qenmu5yWaje;@pa
zX--)<FNHiVgb`{L#Qj7)v6k3L<P&OJ2o<WDvUeL%MLbEYAg0=0Z)ffcmuFPFyMx~i
UaTi9Po93=ra4Fo~oH@(qKR=TL$p8QV

diff --git a/src/backend/locale/fr_FR/LC_MESSAGES/django.po b/src/backend/locale/fr_FR/LC_MESSAGES/django.po
index e7ac86b..eb2cf78 100644
--- a/src/backend/locale/fr_FR/LC_MESSAGES/django.po
+++ b/src/backend/locale/fr_FR/LC_MESSAGES/django.po
@@ -591,39 +591,47 @@ msgstr "Désactivé"
 msgid "Action required"
 msgstr "Action requise"
 
-#: mailbox_manager/models.py:35
+#: mailbox_manager/models.py:33
+msgid "last check details"
+msgstr "détails de la dernière vérification"
+
+#: mailbox_manager/models.py:34
+msgid "A JSON object containing the last health check details"
+msgstr "Un objet JSON contenant les détails de la dernière vérification"
+
+#: mailbox_manager/models.py:39
 msgid "Mail domain"
 msgstr "Domaine de messagerie"
 
-#: mailbox_manager/models.py:36
+#: mailbox_manager/models.py:40
 msgid "Mail domains"
 msgstr "Domaines de messagerie"
 
-#: mailbox_manager/models.py:102
+#: mailbox_manager/models.py:106
 msgid "User/mail domain relation"
 msgstr "Relation entre un utilisateur et un domaine de mail"
 
-#: mailbox_manager/models.py:103
+#: mailbox_manager/models.py:107
 msgid "User/mail domain relations"
 msgstr "Relations entre un utilisateur et un domaine de mail"
 
-#: mailbox_manager/models.py:175
+#: mailbox_manager/models.py:179
 msgid "local_part"
 msgstr "local_part"
 
-#: mailbox_manager/models.py:189
+#: mailbox_manager/models.py:193
 msgid "secondary email address"
 msgstr "adresse email secondaire"
 
-#: mailbox_manager/models.py:199
+#: mailbox_manager/models.py:203
 msgid "Mailbox"
 msgstr "Boîte mail"
 
-#: mailbox_manager/models.py:200
+#: mailbox_manager/models.py:204
 msgid "Mailboxes"
 msgstr "Boîtes mails"
 
-#: mailbox_manager/models.py:224
+#: mailbox_manager/models.py:228
 msgid "You can't create or update a mailbox for a disabled domain."
 msgstr ""
 "Vous ne pouvez pas créer ou modifier une boîte mail pour un domain désactivé."
diff --git a/src/backend/mailbox_manager/migrations/0019_maildomain_last_check_details.py b/src/backend/mailbox_manager/migrations/0019_maildomain_last_check_details.py
new file mode 100644
index 0000000..a724753
--- /dev/null
+++ b/src/backend/mailbox_manager/migrations/0019_maildomain_last_check_details.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.1.5 on 2025-02-07 20:39
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('mailbox_manager', '0018_maildomain_support_email'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='maildomain',
+            name='last_check_details',
+            field=models.JSONField(blank=True, help_text='A JSON object containing the last health check details', null=True, verbose_name='last check details'),
+        ),
+    ]
diff --git a/src/backend/mailbox_manager/models.py b/src/backend/mailbox_manager/models.py
index ca41690..d2905fc 100644
--- a/src/backend/mailbox_manager/models.py
+++ b/src/backend/mailbox_manager/models.py
@@ -30,6 +30,12 @@ class MailDomain(BaseModel):
         choices=MailDomainStatusChoices.choices,
     )
     support_email = models.EmailField(_("support email"), null=False, blank=False)
+    last_check_details = models.JSONField(
+        null=True,
+        blank=True,
+        verbose_name=_("last check details"),
+        help_text=_("A JSON object containing the last health check details"),
+    )
 
     class Meta:
         db_table = "people_mail_domain"
diff --git a/src/backend/mailbox_manager/tests/test_utils_dimail_client.py b/src/backend/mailbox_manager/tests/test_utils_dimail_client.py
index 14e4a64..445db3f 100644
--- a/src/backend/mailbox_manager/tests/test_utils_dimail_client.py
+++ b/src/backend/mailbox_manager/tests/test_utils_dimail_client.py
@@ -194,11 +194,13 @@ def test_dimail__fetch_domain_status__switch_to_enabled(domain_status):
     dimail_client.fetch_domain_status(domain)
     domain.refresh_from_db()
     assert domain.status == enums.MailDomainStatusChoices.ENABLED
+    assert domain.last_check_details == body_content
 
     # call again, should be ok
     dimail_client.fetch_domain_status(domain)
     domain.refresh_from_db()
     assert domain.status == enums.MailDomainStatusChoices.ENABLED
+    assert domain.last_check_details == body_content
 
 
 @pytest.mark.parametrize(
@@ -217,12 +219,12 @@ def test_dimail__fetch_domain_status__switch_to_action_required(
     """Domains should be in status action required when dimail check
     returns broken status for external checks."""
     domain = factories.MailDomainFactory(status=domain_status)
-    body_content = CHECK_DOMAIN_BROKEN_EXTERNAL.copy()
-    body_content["name"] = domain.name
+    body_domain_broken = CHECK_DOMAIN_BROKEN_EXTERNAL.copy()
+    body_domain_broken["name"] = domain.name
     responses.add(
         responses.GET,
         re.compile(rf".*/domains/{domain.name}/check/"),
-        body=json.dumps(body_content),
+        body=json.dumps(body_domain_broken),
         status=status.HTTP_200_OK,
         content_type="application/json",
     )
@@ -230,21 +232,23 @@ def test_dimail__fetch_domain_status__switch_to_action_required(
     dimail_client.fetch_domain_status(domain)
     domain.refresh_from_db()
     assert domain.status == enums.MailDomainStatusChoices.ACTION_REQUIRED
+    assert domain.last_check_details == body_domain_broken
 
     # Support team fixes their part of the problem
     # Now domain is OK again
-    body_content = CHECK_DOMAIN_OK.copy()
-    body_content["name"] = domain.name
+    body_domain_ok = CHECK_DOMAIN_OK.copy()
+    body_domain_ok["name"] = domain.name
     responses.add(
         responses.GET,
         re.compile(rf".*/domains/{domain.name}/check/"),
-        body=json.dumps(body_content),
+        body=json.dumps(body_domain_ok),
         status=status.HTTP_200_OK,
         content_type="application/json",
     )
     dimail_client.fetch_domain_status(domain)
     domain.refresh_from_db()
     assert domain.status == enums.MailDomainStatusChoices.ENABLED
+    assert domain.last_check_details == body_domain_ok
 
 
 @pytest.mark.parametrize(
@@ -261,12 +265,12 @@ def test_dimail__fetch_domain_status__switch_to_failed(domain_status):
     for only internal checks dispite a fix call."""
     domain = factories.MailDomainFactory(status=domain_status)
     # nothing can be done by support team, domain should be in failed
-    body_content = CHECK_DOMAIN_BROKEN_INTERNAL.copy()
-    body_content["name"] = domain.name
+    body_domain_broken = CHECK_DOMAIN_BROKEN_INTERNAL.copy()
+    body_domain_broken["name"] = domain.name
     responses.add(
         responses.GET,
         re.compile(rf".*/domains/{domain.name}/check/"),
-        body=json.dumps(body_content),
+        body=json.dumps(body_domain_broken),
         status=status.HTTP_200_OK,
         content_type="application/json",
     )
@@ -274,7 +278,7 @@ def test_dimail__fetch_domain_status__switch_to_failed(domain_status):
     responses.add(
         responses.GET,
         re.compile(rf".*/domains/{domain.name}/fix/"),
-        body=json.dumps(body_content),
+        body=json.dumps(body_domain_broken),
         status=status.HTTP_200_OK,
         content_type="application/json",
     )
@@ -282,6 +286,7 @@ def test_dimail__fetch_domain_status__switch_to_failed(domain_status):
     dimail_client.fetch_domain_status(domain)
     domain.refresh_from_db()
     assert domain.status == enums.MailDomainStatusChoices.FAILED
+    assert domain.last_check_details == body_domain_broken
 
 
 @pytest.mark.parametrize(
@@ -298,12 +303,12 @@ def test_dimail__fetch_domain_status__full_fix_scenario(domain_status):
     after a fix call."""
     domain = factories.MailDomainFactory(status=domain_status)
     # with all checks KO, domain should be in action required
-    body_content = CHECK_DOMAIN_BROKEN.copy()
-    body_content["name"] = domain.name
+    body_domain_broken = CHECK_DOMAIN_BROKEN.copy()
+    body_domain_broken["name"] = domain.name
     responses.add(
         responses.GET,
         re.compile(rf".*/domains/{domain.name}/check/"),
-        body=json.dumps(body_content),
+        body=json.dumps(body_domain_broken),
         status=status.HTTP_200_OK,
         content_type="application/json",
     )
@@ -311,27 +316,28 @@ def test_dimail__fetch_domain_status__full_fix_scenario(domain_status):
     dimail_client.fetch_domain_status(domain)
     domain.refresh_from_db()
     assert domain.status == enums.MailDomainStatusChoices.ACTION_REQUIRED
+    assert domain.last_check_details == body_domain_broken
 
     # We assume that the support has fixed their part.
     # So now dimail returns OK for external checks but still KO for internal checks.
     # A call to dimail fix endpoint is necessary and will be done by
     # the fetch_domain_status call
-    body_content = CHECK_DOMAIN_BROKEN_INTERNAL.copy()
-    body_content["name"] = domain.name
+    body_domain_broken_internal = CHECK_DOMAIN_BROKEN_INTERNAL.copy()
+    body_domain_broken_internal["name"] = domain.name
     responses.add(
         responses.GET,
         re.compile(rf".*/domains/{domain.name}/check/"),
-        body=json.dumps(body_content),
+        body=json.dumps(body_domain_broken_internal),
         status=status.HTTP_200_OK,
         content_type="application/json",
     )
     # the endpoint fix is called and returns OK. Hooray!
-    body_content = CHECK_DOMAIN_OK.copy()
-    body_content["name"] = domain.name
+    body_domain_ok = CHECK_DOMAIN_OK.copy()
+    body_domain_ok["name"] = domain.name
     responses.add(
         responses.GET,
         re.compile(rf".*/domains/{domain.name}/fix/"),
-        body=json.dumps(body_content),
+        body=json.dumps(body_domain_ok),
         status=status.HTTP_200_OK,
         content_type="application/json",
     )
@@ -339,6 +345,7 @@ def test_dimail__fetch_domain_status__full_fix_scenario(domain_status):
     dimail_client.fetch_domain_status(domain)
     domain.refresh_from_db()
     assert domain.status == enums.MailDomainStatusChoices.ENABLED
+    assert domain.last_check_details == body_domain_ok
 
 
 def test_dimail__enable_pending_mailboxes(caplog):
diff --git a/src/backend/mailbox_manager/utils/dimail.py b/src/backend/mailbox_manager/utils/dimail.py
index d8c48eb..837eb97 100644
--- a/src/backend/mailbox_manager/utils/dimail.py
+++ b/src/backend/mailbox_manager/utils/dimail.py
@@ -456,6 +456,7 @@ class DimailAPIClient:
         ):
             self.enable_pending_mailboxes(domain)
             domain.status = enums.MailDomainStatusChoices.ENABLED
+            domain.last_check_details = dimail_response
             domain.save()
         # if dimail returns broken status, we need to extract external and internal checks
         # and manage the case where the domain has to be fixed by support
@@ -465,6 +466,7 @@ class DimailAPIClient:
             # manage the case where the domain has to be fixed by support
             if not all(external_checks.values()):
                 domain.status = enums.MailDomainStatusChoices.ACTION_REQUIRED
+                domain.last_check_details = dimail_response
                 domain.save()
             # if all external checks are ok but not internal checks, we need to fix internal checks
             elif all(external_checks.values()) and not all(internal_checks.values()):
@@ -479,12 +481,20 @@ class DimailAPIClient:
                 )
                 if all(external_checks.values()) and all(internal_checks.values()):
                     domain.status = enums.MailDomainStatusChoices.ENABLED
+                    domain.last_check_details = dimail_response
                     domain.save()
                 elif all(external_checks.values()) and not all(
                     internal_checks.values()
                 ):
                     domain.status = enums.MailDomainStatusChoices.FAILED
+                    domain.last_check_details = dimail_response
                     domain.save()
+
+        # if no health check data is stored on the domain, we store it now
+        if not domain.last_check_details:
+            domain.last_check_details = dimail_response
+            domain.save()
+
         return dimail_response
 
     def _get_dimail_checks(self, dimail_response, internal: bool):