Merge branch 'bookserver' of github.com:RunestoneInteractive/RunestoneComponents into bookserver

Author: bnmnetp

.jshintrc

@@ -7,7 +7,7 @@
         "allVisualizers",
         "console"
     ],
-    "esversion": 6,
+    "esversion": 8,
     "quotmark": true,
     "strict": "implied",
     "sub": true,

index.rst

@@ -3,6 +3,8 @@ Runestone Components
 ********************
 This site documents the working of the Runestone Components. See the `Runestone Interactive Overview <https://runestone.academy/runestone/books/published/overview/overview.html>`_ or the `Runestone instructor's guide <https://runestone.academy/runestone/static/instructorguide/index.html>`_.
 
+Demo linking to the Runestone Server docs: :ref:`assignments/grades_report endpoint`.
+
 
 Getting started
 ===============

runestone/common/js/bookfuncs.js

@@ -105,8 +105,7 @@ function addReadingList() {
             });
         } else {
             l = $("<div />", {
-                text:
-                    "This page is not part of the last reading assignment you visited.",
+                text: "This page is not part of the last reading assignment you visited.",
             });
         }
         $("#main-content").append(l);
@@ -206,12 +205,26 @@ class PageProgressBar {
 
 export var pageProgressTracker = {};
 
-function handlePageSetup() {
+async function handlePageSetup() {
     var mess;
-    if (eBookConfig.useRunestoneServices) {
-        jQuery.get(eBookConfig.ajaxURL + "set_tz_offset", {
-            timezoneoffset: new Date().getTimezoneOffset() / 60,
-        });
+    let headers = new Headers({
+        "Content-type": "application/json; charset=utf-8",
+        Accept: "application/json",
+    });
+    let data = { timezoneoffset: new Date().getTimezoneOffset() / 60 };
+    let request = new Request("/logger/set_tz_offset", {
+        method: "POST",
+        body: JSON.stringify(data),
+        headers: headers,
+    });
+    try {
+        let response = await fetch(request);
+        if (!response.ok) {
+            console.error(`Failed to set timezone! ${response.statusText}`);
+        }
+        data = await response.json();
+    } catch (e) {
+        console.error(`Error setting timezone ${e}`);
     }
 
     if (eBookConfig.isLoggedIn) {

runestone/common/js/runestonebase.js

@@ -20,7 +20,9 @@ import { pageProgressTracker } from "./bookfuncs.js";
 
 export default class RunestoneBase {
     constructor(opts) {
-        this.component_ready_promise = new Promise(resolve => this._component_ready_resolve_fn = resolve)
+        this.component_ready_promise = new Promise(
+            (resolve) => (this._component_ready_resolve_fn = resolve)
+        );
         this.optional = false;
         if (opts) {
             this.sid = opts.sid;
@@ -57,7 +59,7 @@ export default class RunestoneBase {
                 // is to look for doAssignment in the URL and then grab
                 // the assignment name from the heading.
                 if (location.href.indexOf("doAssignment") >= 0) {
-                    this.timedWrapper = $("h1#assignment_name").text()
+                    this.timedWrapper = $("h1#assignment_name").text();
                 } else {
                     this.timedWrapper = null;
                 }
@@ -72,10 +74,8 @@ export default class RunestoneBase {
         });
     }
 
-    // .. _logBookEvent:
-    //
-    // 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) {
@@ -97,12 +97,17 @@ export default class RunestoneBase {
             try {
                 let response = await fetch(request);
                 if (!response.ok) {
-                    throw new Error("Failed to save the log entry");
+                    let detail = await response.json();
+                    console.error(detail);
+                    throw new Error(`Failed to save the log entry ${detail}`);
+                } else {
+                    post_return = response.json();
                 }
-                post_return = response.json();
             } catch (e) {
                 if (this.isTimed) {
-                    alert(`Error: Your action was not saved! The error was ${e}`);
+                    alert(
+                        `Error: Your action was not saved! The error was ${e}`
+                    );
                 }
                 console.log(`Error: ${e}`);
             }
@@ -120,10 +125,8 @@ export default class RunestoneBase {
         return post_return;
     }
 
-    // .. _logRunEvent:
-    //
-    // 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 = "done";
@@ -192,19 +195,23 @@ export default class RunestoneBase {
                 data.sid = this.sid;
             }
             if (!eBookConfig.practice_mode && this.assessmentTaken) {
-                let request = new Request(
-                    "/assessment/results",
-                    {
-                        method: "POST",
-                        body: JSON.stringify(data),
-                        headers: this.jsonHeaders,
-                    }
-                );
+                let request = new Request("/assessment/results", {
+                    method: "POST",
+                    body: JSON.stringify(data),
+                    headers: this.jsonHeaders,
+                });
                 try {
                     let response = await fetch(request);
-                    data = await response.json();
-                    this.repopulateFromStorage(data);
-                    this.csresolver("server");
+                    if (response.ok) {
+                        data = await response.json();
+                        data = data.detail;
+                        this.repopulateFromStorage(data);
+                        this.csresolver("server");
+                    } else {
+                        alert(
+                            `HTTP Error getting results: ${response.statusText}`
+                        );
+                    }
                 } catch (err) {
                     try {
                         this.checkLocalStorage();
@@ -252,7 +259,7 @@ export default class RunestoneBase {
      */
     repopulateFromStorage(data) {
         // decide whether to use the server's answer (if there is one) or to load from storage
-        if (data !== null && this.shouldUseServer(data)) {
+        if (data !== null && data !== "no data" && this.shouldUseServer(data)) {
             this.restoreAnswers(data);
             this.setLocalStorage(data);
         } else {

runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/layout.html

@@ -243,9 +243,9 @@
     eBookConfig.username = '{{ user_id}}';
     eBookConfig.readings = {{ readings}};
     eBookConfig.activities = {{ activity_info }}
-    eBookConfig.downloadsEnabled = {{downloads_enabled}};
-    eBookConfig.allow_pairs = {{allow_pairs}}
-    eBookConfig.enableCompareMe = {{enable_compare_me}};
+    eBookConfig.downloadsEnabled = {{ downloads_enabled}};
+    eBookConfig.allow_pairs = {{ allow_pairs}}
+    eBookConfig.enableCompareMe = {{ enable_compare_me }};
     {% endraw %}
   {% else %}
     eBookConfig.useRunestoneServices = {% if use_services == 'true' -%}true{%- else -%}false{%- endif -%};

runestone/server/componentdb.py

@@ -128,7 +128,9 @@ def setup(app):
     logger.info("Connecting to DB")
     try:
         dburl = get_dburl()
-        engine = create_engine(dburl, client_encoding="utf8", convert_unicode=True)
+        # SQLite doesn't support ``client_encoding``, while PostgreSQL does.
+        encoding = dict(client_encoding="utf8") if dburl.startswith("postgresql") else {}
+        engine = create_engine(dburl, convert_unicode=True, **encoding)
         Session = sessionmaker()
         engine.connect()
         Session.configure(bind=engine)
@@ -339,6 +341,7 @@ def addQuestionToDB(self):
                     practice=practice,
                     topic=topics,
                     from_source=from_source,
+                    review_flag='F',
                     optional=optional,
                     description=et,
                     **meta_opts,
@@ -388,6 +391,7 @@ def addQuestionToDB(self):
                     question_name=id_,
                 )
                 sess.execute(ins)
+            sess.commit()
 
 
 def addQNumberToDB(app, node, qnumber):
@@ -585,7 +589,6 @@ def addAssignmentToDB(
         return
 
     course_id = getCourseID(course_name)
-    last_changed = datetime.now()
     sel = select([assignments]).where(
         and_(assignments.c.name == name, assignments.c.course == course_id)
     )
@@ -624,6 +627,7 @@ def addAssignmentToDB(
             visible=visible,
             time_limit=time_limit,
             from_source="T",
+            released="F",
         )
         res = sess.execute(ins)
         a_id = res.inserted_primary_key[0]

runestone/timed/js/timed.js

@@ -997,6 +997,8 @@ export default class Timed extends RunestoneBase {
         });
         localStorage.setItem(this.localStorageKey(), storageObj);
     }
+    // _`timed exam endpoint parameters`
+    //----------------------------------
     logScore() {
         this.logBookEvent({
             event: "timedExam",

setup.py

@@ -10,7 +10,7 @@
 with open("requirements.txt", "r", encoding="utf-8") as fh:
     dependencies = [l.strip() for l in fh]
 
-VERSION = "5.6.1"
+VERSION = "6.0.0dev"
 
 # These pre-install hooks are useful to make sure any pre-requisite
 # programs that are not pip installable are in place.