Log a message when a retried requests succeeds

lms/static/scripts/frontend_apps/utils/api.ts

@@ -78,6 +78,9 @@ export type APICallOptions = {
 
   /** Signal that can be used to cancel the request. */
   signal?: AbortSignal;
+
+  /** Additional headers to include in the request. */
+  extraHeaders?: Record<string, string>;
 };
 
 function delay(ms: number) {
@@ -107,12 +110,14 @@ export async function apiCall<Result = unknown>(
     retryCount = 0,
     retryDelay = 1000,
     signal,
+    extraHeaders,
   } = options;
 
   let body;
 
   const headers: Record<string, string> = {
     Authorization: authToken,
+    ...extraHeaders,
   };
 
   if (data !== undefined) {
@@ -136,7 +141,14 @@ export async function apiCall<Result = unknown>(
       retryCount < maxRetries
     ) {
       await delay(retryDelay);
-      return apiCall({ ...options, retryCount: retryCount + 1 });
+      return apiCall({
+        ...options,
+        extraHeaders: {
+          ...extraHeaders,
+          ['Retry-Count']: (retryCount + 1).toString(),
+        },
+        retryCount: retryCount + 1,
+      });
     }
 
     // Refresh expired access tokens for external APIs, if required. Only one

lms/views/api/grading.py

@@ -14,6 +14,7 @@
     APIRecordResultSchema,
     APIRecordSpeedgraderSchema,
 )
+from lms.views.helpers import log_retries_callback
 
 LOG = logging.getLogger(__name__)
 
@@ -150,6 +151,7 @@ def record_canvas_speedgrader_submission(self):
         self.request.registry.notify(
             LTIEvent.from_request(request=self.request, type_=LTIEvent.Type.SUBMISSION)
         )
+        self.request.add_finished_callback(log_retries_callback)
         return {}
 
 

lms/views/helpers/__init__.py

@@ -1,3 +1,4 @@
+from lms.views.helpers._logging import log_retries_callback
 from lms.views.helpers._via import via_url, via_video_url
 
-__all__ = ["via_url", "via_video_url"]
+__all__ = ["log_retries_callback", "via_url", "via_video_url"]

lms/views/helpers/_logging.py

@@ -0,0 +1,17 @@
+import logging
+
+LOG = logging.getLogger(__name__)
+
+
+def log_retries_callback(request):
+    """Log a message when a retried requests succeeds."""
+    if (
+        request.headers.get("Retry-Count")
+        and request.response.status_code >= 200
+        and request.response.status_code < 300
+    ):
+        LOG.debug(
+            "Request to %s succeeded after %s retries",
+            request.path_info,
+            request.headers["Retry-Count"],
+        )