Merge ~r00ta/maas:lp-2034014-add-retry-header-for-409-responses into maas:master

[Jacopo Rota]

add retry-after header in 409 responses

See https://bugs.launchpad.net/maas/+bug/2034014/comments/6 for more details about this change.

The PR on gomaasapi is here https://github.com/juju/gomaasapi/pull/101

[MAAS Lander (maas-lander)]

UNIT TESTS
-b lp-2034014-add-retry-header-for-409-responses lp:~r00ta/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: a8338c932351b70a0093eacc2de46f084d1cb355

review: Approve

c70d770... by Jacopo Rota on 2023-09-08

remove leftover

[MAAS Lander (maas-lander)]

UNIT TESTS
-b lp-2034014-add-retry-header-for-409-responses lp:~r00ta/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: c70d770b4da8bd401e96ce6bc0ed5a7c75d21638

review: Approve

[Jack Lloyd-Walters (lloydwaltersj)]

LGTM, tests passing and change is small so... +1

review: Approve

diff --git a/src/maasserver/utils/tests/test_views.py b/src/maasserver/utils/tests/test_views.py
index e456a1e..f53dfd4 100644
--- a/src/maasserver/utils/tests/test_views.py
+++ b/src/maasserver/utils/tests/test_views.py
@@ -382,6 +382,7 @@ class TestWebApplicationHandler(SerializationFailureTestCase):
             MockCallsMatch(call(request), call(request), call(request)),
         )
         self.assertIsInstance(response, HttpResponseConflict)
+        self.expectThat(response["Retry-After"], Equals("5"))
         self.expectThat(response.status_code, Equals(http.client.CONFLICT))
         self.expectThat(
             response.reason_phrase,
diff --git a/src/maasserver/utils/views.py b/src/maasserver/utils/views.py
index 18b67b9..e20c5e1 100644
--- a/src/maasserver/utils/views.py
+++ b/src/maasserver/utils/views.py
@@ -38,6 +38,8 @@ from provisioningserver.utils.twisted import retries
 
 logger = logging.getLogger(__name__)
 
+RETRY_AFTER_CONFLICT = 5
+
 
 class InternalErrorResponse(BaseException):
     """Exception raised to exit the transaction context.
@@ -149,6 +151,9 @@ class HttpResponseConflict(MAASDjangoTemplateResponse):
 
     def __init__(self, response=None, exc_info=None):
         super().__init__(response=response)
+        # Responses with status code 409 should be retried by the clients
+        # see https://bugs.launchpad.net/maas/+bug/2034014/comments/6 for more information
+        self["Retry-After"] = RETRY_AFTER_CONFLICT
         self.exc_info = exc_info