refactor: [AXM-361] remove dead code and add docstrings

lms/static/js/courseware/bridge.js

@@ -1,32 +1,51 @@
+/**
+ * JS bridge for communication between the native mobile apps and the xblock.
+ *
+ * This script is used to send data about student's answer to the native mobile apps (IOS and Android)
+ * and to receive data about student's answer from the native mobile apps to fill the form
+ * with the student's answer, disable xblock inputs and mark the problem as completed.
+ *
+ * Separate functions for each platform allow you to flexibly add platform-specific logic
+ * as needed without changing the naming on the mobile side.
+ */
+
+/**
+ * Sends a data about student's answer to the IOS app.
+ *
+ * @param {string} message The stringified JSON object to be sent to the IOS app
+ */
 function sendMessageToIOS(message) {
   window?.webkit?.messageHandlers?.IOSBridge?.postMessage(message);
 }
 
+/**
+ * Sends a data about student's answer to the Android app.
+ *
+ * @param {string} message The stringified JSON object to be sent to the native Android app
+ */
 function sendMessageToAndroid(message) {
   window?.AndroidBridge?.postMessage(message);
 }
 
-function markProblemCompletedIOS(message) {
-  markProblemCompleted(message);
-}
-
-function markProblemCompletedAndroid(message) {
-  markProblemCompleted(message);
-}
-
+/**
+ * Receives a message from the mobile apps and fills the form with the student's answer,
+ * disables xblock inputs and marks the problem as completed with appropriate message.
+ *
+ * @param {string} message The stringified JSON object about the student's answer from the native mobile app.
+ */
 function markProblemCompleted(message) {
   const data = JSON.parse(message).data;
-
-  const prob = $(".xblock-student_view");
-  prob.find('.submit-attempt-container .submit').attr({disabled: "disabled"});
-  prob.find('.notification-gentle-alert .notification-message').html("Answer submitted.");
-  prob.find('.notification-gentle-alert').show();
-
+  const problemContainer = $(".xblock-student_view");
+  const submitButton = problemContainer.find(".submit-attempt-container .submit");
+  const notificationContainer = problemContainer.find(".notification-gentle-alert");
+  submitButton.attr({disabled: "disabled"});
+  notificationContainer.find(".notification-message").html("Answer submitted.");
+  notificationContainer.show();
 
   data.split("&").forEach(function (item) {
-    const [input, answer] = item.split('=', 2);
-    prob.find('input[id$="' + answer + '"], input[id$="' + input + '"]').each(function () {
-      $(this).attr({disabled: "disabled"})
+    const [inputId, answer] = item.split('=', 2);
+    problemContainer.find('input[id$="' + answer + '"], input[id$="' + inputId + '"]').each(function () {
+      this.disabled = true;
       if (this.type === "checkbox" || this.type === "radio") {
         this.checked = true;
       } else {
@@ -36,18 +55,12 @@ function markProblemCompleted(message) {
   })
 }
 
-if (window.webkit && window.webkit.messageHandlers && window.webkit.messageHandlers.IOSBridge) {
-  window.addEventListener("messageFromIOS", function (event) {
-    markProblemCompletedIOS(event.data);
-  });
-}
-
-if (window.AndroidBridge) {
-  window.addEventListener("messageFromAndroid", function (event) {
-    markProblemCompletedAndroid(event.data);
-  });
-}
-
+/**
+ * Overrides the default $.ajax function to intercept the requests to the "problem_check" endpoint
+ * and send the data to the native mobile apps.
+ *
+ * @param {Object} options The data object for the ajax request
+ */
 const originalAjax = $.ajax;
 $.ajax = function (options) {
   if (options.url && options.url.endsWith("problem_check")) {