Fix: Make logRunEvent consistent with logBookEvent.

Author: bjones1

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

@@ -57,7 +57,11 @@ export default class RunestoneBase {
         }
     }
 
-    // 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).
+// .. _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;
@@ -95,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;
         }
@@ -116,11 +126,11 @@ export default class RunestoneBase {
                 headers: headers,
                 body: JSON.stringify(eventInfo),
             });
-            post_promise = await fetch(request);
-            post_promise = await fetch(request);
-            if (!post_promise.ok) {
+            let response = await fetch(request);
+            if (!response.ok) {
                 throw new Error("Failed to log the run");
             }
+            post_promise = await response.json();
         }
         console.log("running " + JSON.stringify(eventInfo));
         if (

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