Build: use a longer and more accurate expiricy time for API key (#12425)

This formula considers builds that are retried multiple times.

Author: humitos

readthedocs/api/v2/models.py

@@ -16,11 +16,17 @@ def create_key(self, project):
         """
         Create a new API key for a project.
 
-        Build API keys are valid for 3 hours,
+        Build API keys are valid for
+
+        - project or default build time limit
+        - plus 25% to cleanup task once build is finished
+        - plus extra time to allow multiple retries (concurrency limit reached)
+
         and can be revoked at any time by hitting the /api/v2/revoke/ endpoint.
         """
-        # Use the project or default build time limit + 25% for the API token
-        delta = (project.container_time_limit or settings.BUILD_TIME_LIMIT) * 1.25
+        delta = (
+            project.container_time_limit or settings.BUILD_TIME_LIMIT
+        ) * 1.25 + settings.RTD_BUILDS_RETRY_DELAY * settings.RTD_BUILDS_MAX_RETRIES
         expiry_date = timezone.now() + timedelta(seconds=delta)
         name_max_length = self.model._meta.get_field("name").max_length
         return super().create_key(

readthedocs/rtd_tests/tests/test_api.py

@@ -766,6 +766,19 @@ def test_revoke_build_api_key(self):
         self.assertEqual(resp.status_code, 204)
         self.assertFalse(BuildAPIKey.objects.is_valid(build_api_key))
 
+    def test_expiricy_key(self):
+        project = get(Project)
+        build_api_key_obj, build_api_key = BuildAPIKey.objects.create_key(project)
+        expected = (build_api_key_obj.expiry_date - timezone.now()).seconds
+        self.assertAlmostEqual(expected, 8250, delta=5)
+
+        # Project with a custom containe time limit
+        project.container_time_limit = 1200
+        project.save()
+        build_api_key_obj, build_api_key = BuildAPIKey.objects.create_key(project)
+        expected = (build_api_key_obj.expiry_date - timezone.now()).seconds
+        self.assertAlmostEqual(expected, 9000, delta=5)
+
     def test_user_doesnt_get_full_api_return(self):
         user_normal = get(User, is_staff=False)
         user_admin = get(User, is_staff=True)