Merge pull request #1105 from bjones1/logBook_async

Fix: Return data from the server, instead of the HTTP response, from …

Author: bnmnetp

runestone/activecode/js/activecode_js.js

@@ -55,6 +55,7 @@ export default class JSActiveCode extends ActiveCode {
             this.addErrorMessage(e);
             einfo = e;
         }
+        // Note that, since this isn't awaited, the request may not be complete when this function returns.
         this.logRunEvent({
             div_id: this.divid,
             code: this.editor.getValue(),
@@ -64,6 +65,6 @@ export default class JSActiveCode extends ActiveCode {
             prefix: this.pretext,
             suffix: this.suffix,
             partner: this.partner,
-        }); // Log the run event
+        });
     }
 }

runestone/common/js/runestonebase.js

@@ -61,11 +61,16 @@ export default class RunestoneBase {
         });
     }
 
+// .. _logBookEvent:
+//
+// logBookEvent
+// ------------
+    // This function sends the provided ``eventInfo`` to the `hsblog endpoint` of the server. Awaiting this function returns either ``undefined`` (if Runestone services are not available) or the data returned by the server as a JavaScript object (already JSON-decoded).
     async logBookEvent(eventInfo) {
         if (this.graderactive) {
             return;
         }
-        let post_return = Promise.resolve();
+        let post_return;
         eventInfo.course = eBookConfig.course;
         eventInfo.clientLoginStatus = eBookConfig.isLoggedIn;
         eventInfo.timezoneoffset = new Date().getTimezoneOffset() / 60;
@@ -78,10 +83,11 @@ export default class RunestoneBase {
                 headers: this.jsonHeaders,
                 body: JSON.stringify(eventInfo),
             });
-            post_return = await fetch(request);
-            if (!post_return.ok) {
+            let response = await fetch(request);
+            if (!response.ok) {
                 throw new Error("Failed to save the log entry");
             }
+            post_return = response.json();
         }
         console.log("logging event " + JSON.stringify(eventInfo));
         if (
@@ -93,8 +99,14 @@ export default class RunestoneBase {
         }
         return post_return;
     }
+
+// .. _logRunEvent:
+//
+// logRunEvent
+// -----------
+    // This function sends the provided ``eventInfo`` to the `runlog endpoint`. When awaited, this function returns the data (decoded from JSON) the server sent back.
     async logRunEvent(eventInfo) {
-        let post_promise = Promise.resolve("done");
+        let post_promise = "done";
         if (this.graderactive) {
             return;
         }
@@ -114,6 +126,7 @@ export default class RunestoneBase {
             if (!post_promise.ok) {
                 throw new Error("Failed to log the run");
             }
+            post_promise = await response.json();
         }
         console.log("running " + JSON.stringify(eventInfo));
         if (

runestone/fitb/js/fitb.js

@@ -241,10 +241,9 @@ export default class FITB extends RunestoneBase {
         }
         if (logFlag) {
             // Sometimes we don't want to log the answer--for example, when timed exam questions are re-loaded
-            let ret = await this.logCurrentAnswer();
+            let data = await this.logCurrentAnswer();
             if (!this.feedbackArray) {
                 // On success, update the feedback from the server's grade.
-                let data = await ret.json();
                 this.setLocalStorage({
                     answer: JSON.stringify(this.given_arr),
                     timestamp: data.timestamp,

runestone/mchoice/test/test_assess.py

@@ -6,7 +6,6 @@
 
 from unittest import TestCase
 from selenium.webdriver.support import expected_conditions as EC
-from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.common.by import By
 from runestone.unittest_base import module_fixture_maker, RunestoneTestCase
 
@@ -63,12 +62,6 @@ class MultipleChoiceQuestion_Tests(RunestoneTestCase):
     def test_ma1(self):
         """Multiple Answer: Nothing selected, Check button clicked"""
         self.driver.get(self.host + "/index.html")
-        wait = WebDriverWait(self.driver, 10)
-        try:
-            wait.until(EC.presence_of_element_located((By.ID, "question1")))
-        except:
-            text = self.driver.page_source
-            print(text[:300])
         t1 = self.driver.find_element_by_id("question1")
 
         btn_check = t1.find_element_by_tag_name("button")

runestone/overview.rst

@@ -3,27 +3,27 @@ Consistent Component API
 
 A standardized API will make the Runestone Components easier to work on and more maintainable.  For example in trying to find out how to JUST score a component in a timed exam (not render any feedback) I found the following methods:
 
-* processXXXSubmissions - mchoice
-* startEvaluation - fitb
-* dragEval - dragndrop
-* checkMe - parsons
-* clickableEval - clickaablearea
-* activecode - runProg
-* submitJournal - short answer
+*   processXXXSubmissions - mchoice
+*   startEvaluation - fitb
+*   dragEval - dragndrop
+*   checkMe - parsons
+*   clickableEval - clickaablearea
+*   activecode - runProg
+*   submitJournal - short answer
 
 All of the above mix the scoring of the component with rendering the feedback.  I would like to separate those two things and standardize on some names for doing so.
 
 Base Class Provides
 -------------------
-* shouldUseServer
-* checkServer
-* logRunEvent
-* logBookEvent
-* loadData
-* repopulateFromStorage
-* localStorageKey
-* addCaption
-* constructor that takes opts
+*   shouldUseServer
+*   checkServer
+*   `logRunEvent` - send the results of executing an ActiveCode exercise to the `runlog endpoint`.
+*   `logBookEvent` - send the results of answering a question to the `hsblog endpoint`.
+*   loadData
+*   repopulateFromStorage
+*   localStorageKey
+*   addCaption
+*   constructor that takes opts
 
 All Components
 --------------
@@ -33,14 +33,12 @@ All Components
 * setLocalStorage
 * checkLocalStorage
 * hasUserActivity
-* 
-Gradable 
---------
 
+Gradable
+--------
 Each Gradable should provide these three functions as an external API.  We want to separate checking, from logging and providing feedback
-* checkCurrentAnswer - async? so that for server side grading we can await
-* logCurrentAnswer
-* renderFeedback
-* disableInteraction
-
 
+*   checkCurrentAnswer - async? so that for server side grading we can await
+*   logCurrentAnswer
+*   renderFeedback
+*   disableInteraction

runestone/unittest_base.py

@@ -228,6 +228,8 @@ def setUp(self):
         # Use the shared module-wide driver.
         self.driver = mf.driver
         self.host = HOST_URL
+        # Add an `implicit wait <https://selenium-python.readthedocs.io/waits.html#implicit-waits>`_.
+        self.driver.implicitly_wait(5)
 
     def tearDown(self):
         # Clear as much as possible, to present an almost-fresh instance of a browser for the next test. (Shutting down then starting up a browswer is very slow.)