Added logging for CodeTailor puzzles to a new table.

xinyinghou · xinyinghou · commit f04b767a1c3e · 2026-01-25T20:45:24.000Z
diff --git a/bases/rsptx/book_server_api/routers/rslogging.py b/bases/rsptx/book_server_api/routers/rslogging.py
@@ -38,6 +38,7 @@
 from rsptx.db.crud import (
     create_answer_table_entry,
     create_code_entry,
+    create_code_tailor_parsons_entry,
     create_useinfo_entry,
     create_user_chapter_progress_entry,
     create_user_state_entry,
@@ -60,6 +61,7 @@
 from rsptx.db.models import (
     AuthUserValidator,
     CodeValidator,
+    CodeTailorParsonsValidator,
     runestone_component_dict,
     UseinfoValidation,
 )
@@ -68,6 +70,7 @@
     LastPageDataIncoming,
     LogItemIncoming,
     LogRunIncoming,
+    LogCodeTailorIncoming,
     TimezoneRequest,
     ReadingAssignmentSpec,
 )
@@ -309,6 +312,55 @@ async def runlog(request: Request, response: Response, data: LogRunIncoming):
 
     return make_json_response(status=status.HTTP_201_CREATED)
 
+# codetailorlog endpoint
+# ---------------
+# The :ref:`logCodeTailorEvent` client-side function calls this endpoint to record a CodeTailor puzzle creation
+@router.post("/codetailor_log")
+async def codetailor_log(request: Request, response: Response, data: LogCodeTailorIncoming):
+    """Make an entry in the CodeTailorParsons table to record a CodeTailor Parsons puzzle creation.
+
+    :param request: A FastAPI Request object
+    :param response: A FastAPI Response object
+    :type response: JSONResponse
+    :param data: the post data
+    :type data: LogCodeTailorIncoming
+    :return: JSONResponse
+    """
+    rslogger.debug(f"INCOMING: {data}")
+
+    # --- Auth / session checks (same pattern as /runlog) ---
+    if request.state.user:
+        if data.course != request.state.user.course_name:
+            return make_json_response(
+                status=status.HTTP_401_UNAUTHORIZED,
+                detail="You appear to have changed courses in another tab. Please switch to this course",
+            )
+        sid = request.state.user.username
+        course_id = request.state.user.course_id
+    else:
+        if data.clientLoginStatus is True:
+            rslogger.error("Session Expired")
+            return make_json_response(
+                status=status.HTTP_401_UNAUTHORIZED,
+                detail="Session Expired",
+            )
+        return make_json_response(status=status.HTTP_401_UNAUTHORIZED)
+
+    codetailor_row = {
+        "timestamp": canonical_utcnow(),
+        "sid": sid,
+        "ctid": data.ctid,
+        "course_id": course_id,
+        "htmlsrc": data.htmlsrc,
+        "question_json": data.question_json,
+    }
+
+    entry = CodeTailorParsonsValidator(**codetailor_row)
+    await create_code_tailor_parsons_entry(entry)
+
+    return make_json_response(status=status.HTTP_201_CREATED)
+
+
 
 async def same_class(user1: AuthUserValidator, user2: str) -> bool:
     if user1:
diff --git a/bases/rsptx/interactives/runestone/activecode/js/activecode.js b/bases/rsptx/interactives/runestone/activecode/js/activecode.js
@@ -80,7 +80,8 @@ export class ActiveCode extends RunestoneBase {
         this.code = $(orig).text() || "\n\n\n\n\n";
         this.parsonspersonalize = $(orig).data("parsonspersonalize"); // CodeTailor: <choose 1 out of two> Allows the instructor to choose personalization level: solution-level or block-and-solution level
         this.parsonsexample = $(orig).data("parsonsexample"); // CodeTailor: <choose 1 out of two> Allows the instructor to choose an example Parsons problem or LLM-example (default auto-fill, means the example is generated by LLM)
-        this.puzzleScaffoldingDivid = `help_puzzle_${this.parsonspersonalize}_${this.divid}`; // CodeTailor: the div id for the puzzle scaffolding help window
+        this.codetailortimestamp = Math.floor(Date.now() / 1000);
+        this.puzzleScaffoldingDivid = `${this.divid}_codetailor_${this.parsonspersonalize}_${this.sid}_${this.codetailortimestamp}`; // CodeTailor: the div id for the puzzle scaffolding help window
         this.language = $(orig).data("lang");
         this.timelimit = $(orig).data("timelimit");
         this.highlightLines = $(orig).data("highlight-lines");
@@ -635,6 +636,7 @@ export class ActiveCode extends RunestoneBase {
         return promise;
     }
 
+
     // isNewHelp: when true, this handler was not called by pressing the button.
     //            it was used to open a new generated help.
     async reopenHelpBtnHandler(isNewHelp) {
@@ -693,9 +695,9 @@ export class ActiveCode extends RunestoneBase {
                 reopen: true,
             }
             this.logBookEvent({
-                event: "gptparsons_base_reopen",
+                event: "codetailor_base_reopen",
                 act: JSON.stringify(reopen_act),
-                div_id: this.divid
+                div_id: this.puzzleScaffoldingDivid
             });
             return;
         }
@@ -732,66 +734,45 @@ export class ActiveCode extends RunestoneBase {
         
         // Function to handle sending the rest of the data and splitting large strings into chunks
         const logActInParts = (act) => {
-            // First, send the smaller fields (non-chunked) with event name "gptparsons-0"
+            // First, send the smaller fields (non-chunked) with event name "codetailor-0"
             const basicData = {
                 type: act.type,
                 reopen: act.reopen,
                 generation_type: act.generation_type,
                 solution_type: act.solution_type,
             };
 
-            // First, send the smaller fields (non-chunked) with event name "gptparsons-0"
+            // First, send the smaller fields (non-chunked) with event name "codetailor-0"
             // // console.log("Sending basic data:", basicData);
             this.logBookEvent({
-                event: "gptparsons_base",  // Special event name for the first log
+                event: "codetailor_base",  // Special event name for the first log
                 act: JSON.stringify(basicData),
-                div_id: this.divid
+                div_id: this.puzzleScaffoldingDivid
             });
 
             // Split and send the code chunks
-            if (act.code_answer) {
-                let chunkIndex = 1; // Initialize a single counter for all chunks
-                const codeChunks = splitIntoChunks(act.code_answer, 512);
-                codeChunks.forEach((chunk) => {
-                    this.logBookEvent({
-                        event: `gptparsons_code_${chunkIndex}`,
-                        act: JSON.stringify({ 
-                            reopen: !isNewHelp, 
-                            type: 'code',
-                            content: chunk, 
-                            chunkIndex: chunkIndex, 
-                            totalChunks: codeChunks.length + (act.puzzle ? splitIntoChunks(act.puzzle, 512).length : 0)
-                        }),
-                        div_id: this.divid
-                    });
-                    chunkIndex++;
-                });
-            }
+            const puzzle_json = {
+                type: act.type,
+                generation_type: act.generation_type,
+                solution_type: act.solution_type,
+                code_answer: act.code_answer || null,
+            };
 
-            // Split and send the puzzle chunks if they exist
-            if (act.puzzle) {
-                const puzzleChunks = splitIntoChunks(act.puzzle, 512);
-                let puzzleIndex = 1;
-                puzzleChunks.forEach((chunk) => {
-                    this.logBookEvent({
-                        event: `gptparsons_puzzle_${puzzleIndex}`,
-                        act: JSON.stringify({ 
-                            reopen: !isNewHelp, 
-                            type: 'puzzle',
-                            content: chunk, 
-                            chunkIndex: puzzleIndex,
-                            totalChunks: puzzleChunks.length
-                        }),
-                        div_id: this.divid
-                    });
-                    puzzleIndex++;
-                });
-            }
+            // Send ONE request to the new table
+            this.logCodeTailorEvent({
+                div_id: this.divid,
+                sid: this.sid,
+                ctid: this.puzzleScaffoldingDivid,
+                course: this.courseName,                 // must match request.state.user.course_name
+                htmlsrc: this.puzzleHTML || null,       // raw puzzle HTML 
+                puzzle_json: puzzle_json,             // JSON column
+            });
         }
 
         // Log the data in parts
         logActInParts(act);
 
+
         let probDescHTML = $(this.outerDiv).find(".ac_question").last().html();
         if (puzzle_rst !== "correctCode" && puzzle_rst !== "emptyHelpParsons") {
             var puzzleCode = `
@@ -851,9 +832,9 @@ export class ActiveCode extends RunestoneBase {
                     type: 'close_help'
                 }
                 this.logBookEvent({
-                    event: "gptparsons_close",
+                    event: "codetailor_close",
                     act: JSON.stringify({ ...act }), // Clone to avoid future changes affecting the log
-                    div_id: close_divId
+                    div_id: this.puzzleScaffoldingDivid
                 });
                 $(`#scaffolding-container-${this.divid}`).addClass('hidden');
             }
@@ -913,9 +894,9 @@ export class ActiveCode extends RunestoneBase {
                 type: 'copy_help'
             }
             this.logBookEvent({
-                event: "gptparsons_copy",
+                event: "codetailor_copy",
                 act: JSON.stringify({ ...act }), // Clone to avoid future changes affecting the log
-                div_id: this.divid
+                div_id: this.puzzleScaffoldingDivid
             });
             $(`#copy-answer-button-${this.puzzleScaffoldingDivid}`).text('Copied!').prop('disabled', true);
 
@@ -1018,9 +999,9 @@ export class ActiveCode extends RunestoneBase {
         }
 
         this.logBookEvent({
-            event: "gptparsons_request_base",
+            event: "codetailor_request_base",
             act: this.parsonspersonalize,
-            div_id: this.divid
+            div_id: this.puzzleScaffoldingDivid
         });
 
         // Split and send the code chunks
@@ -1029,14 +1010,14 @@ export class ActiveCode extends RunestoneBase {
             const codeChunks = splitIntoChunks(request_act.code, 512);
             codeChunks.forEach((chunk) => {
                 this.logBookEvent({
-                    event: `gptparsons_request_code_${requestChunkIndex}`,
+                    event: `codetailor_request_code_${requestChunkIndex}`,
                     act: JSON.stringify({ 
                         type: 'code',
                         content: chunk, 
                         requestChunkIndex: requestChunkIndex, 
                         totalChunks: requestChunkIndex.length + splitIntoChunks(request_act.code, 512).length
                     }),
-                    div_id: this.divid
+                    div_id: this.puzzleScaffoldingDivid
                 });
                 requestChunkIndex++;
             });
diff --git a/bases/rsptx/interactives/runestone/common/js/runestonebase.js b/bases/rsptx/interactives/runestone/common/js/runestonebase.js
@@ -337,6 +337,73 @@ export default class RunestoneBase {
         }
         return post_promise;
     }
+
+    // logCodeTailorEvent
+    // ------------------
+    // This function sends the provided ``eventInfo`` to the `codetailor_log endpoint` of the server.
+    // This function is modified based on logRunEvent and logBookEvent
+    async logCodeTailorEvent(eventInfo) {
+        if (this.graderactive) {
+            return;
+        }
+
+        let post_return;
+
+        // Match backend expectations
+        eventInfo.course = eBookConfig.course;
+        eventInfo.clientLoginStatus = eBookConfig.isLoggedIn;
+        eventInfo.timezoneoffset = new Date().getTimezoneOffset() / 60;
+
+        if (
+            eBookConfig.isLoggedIn &&
+            eBookConfig.useRunestoneServices &&
+            eBookConfig.logLevel > 0
+        ) {
+            let request = new Request(
+                `${eBookConfig.new_server_prefix}/logger/codetailor_log`,
+                {
+                    method: "POST",
+                    headers: this.jsonHeaders,
+                    body: JSON.stringify(eventInfo),
+                }
+            );
+
+            let response = await fetch(request);
+
+            if (!response.ok) {
+                post_return = await response.json();
+                if (eBookConfig.useRunestoneServices) {
+                    alert(`Failed to log your CodeTailor event
+                        Status is ${response.status}
+                        Detail: ${JSON.stringify(post_return.detail, null, 4)}`);
+                } else {
+                    console.log(
+                        `Did not log the CodeTailor event.
+                        Status: ${response.status}
+                        Detail: ${JSON.stringify(post_return.detail, null, 4)}`
+                    );
+                }
+            } else {
+                post_return = await response.json();
+            }
+        }
+
+        if (!this.isTimed || eBookConfig.debug) {
+            let prefix = eBookConfig.isLoggedIn ? "Save" : "Not";
+            console.log(`${prefix} codetailor logging ` + JSON.stringify(eventInfo));
+        }
+
+        if (
+            typeof pageProgressTracker.updateProgress === "function" &&
+            this.optional == false
+        ) {
+            pageProgressTracker.updateProgress(eventInfo.ctid);
+        }
+
+        return post_return;
+    }
+
+
     /* Checking/loading from storage
     **WARNING:**  DO NOT `await` this function!
     This function, although async, does not explicitly resolve its promise by returning a value.  The reason for this is because it is called by the constructor for nearly every component.  In Javascript constructors cannot be async!
diff --git a/bases/rsptx/interactives/runestone/parsons/js/parsons.js b/bases/rsptx/interactives/runestone/parsons/js/parsons.js
@@ -1753,7 +1753,7 @@ export default class Parsons extends RunestoneBase {
                 $(this.checkButton).prop("disabled", true);
                 // CodeTailor: make the Copy Answer button visible when the puzzle is solved
                 if (this.hasSolved && this.options.scaffolding) {
-                    const copyBtn = document.querySelector(`#copy-answer-button-${this.divid}`); // copy-answer-button-${puzzleScaffoldingDivid}
+                    const copyBtn = document.querySelector(`#copy-answer-button-${this.puzzleScaffoldingDivid}`); // copy-answer-button-${puzzleScaffoldingDivid}
                     if (copyBtn) {
                         copyBtn.classList.remove('copy-button-hide');
                     }
@@ -2998,7 +2998,7 @@ export default class Parsons extends RunestoneBase {
         this.clearFeedback();
         // CodeTailor: Hide the Copy Answer Button again
         if (this.options.scaffolding === true) {
-            const copyBtn = document.querySelector(`#copy-answer-button-${this.divid}`); // copy-answer-button-${puzzleScaffoldingDivid}
+            const copyBtn = document.querySelector(`#copy-answer-button-${this.puzzleScaffoldingDivid}`); // copy-answer-button-${puzzleScaffoldingDivid}
             if (copyBtn) {
                 copyBtn.classList.add('copy-button-hide');
             }
diff --git a/components/rsptx/db/crud/__init__.py b/components/rsptx/db/crud/__init__.py
@@ -167,6 +167,7 @@
     count_useinfo_for,
     create_answer_table_entry,
     create_code_entry,
+    create_code_tailor_parsons_entry,
     create_useinfo_entry,
     fetch_code,
     fetch_last_answer_table_entry,
@@ -395,6 +396,7 @@
     "count_useinfo_for",
     "create_answer_table_entry",
     "create_code_entry",
+    "create_code_tailor_parsons_entry",
     "create_useinfo_entry",
     "fetch_code",
     "fetch_last_answer_table_entry",
diff --git a/components/rsptx/db/crud/rslogging.py b/components/rsptx/db/crud/rslogging.py
@@ -10,6 +10,8 @@
     Code,
     CodeValidator,
     runestone_component_dict,
+    CodeTailorParsons,
+    CodeTailorParsonsValidator,
 )
 from ..async_session import async_session
 from rsptx.validation import schemas
@@ -250,3 +252,20 @@ async def fetch_code(
         # We retrieved most recent first, but want to return results in chronological order
         code_list.reverse()
         return code_list
+
+# CodeTailorParsons
+# ----
+# write a function that takes a CodeTailorParsonsValidator as a parameter and inserts a new CodeTailorParsons into the database
+async def create_code_tailor_parsons_entry(data: CodeTailorParsonsValidator) -> CodeTailorParsonsValidator:
+    """
+    Create a new CodeTailorParsons entry with the given data
+
+    :param data: CodeTailorParsonsValidator, validated input data
+    :return: CodeTailorParsonsValidator, the newly created entry
+    """
+    new_entry = CodeTailorParsons(**data.dict())
+
+    async with async_session.begin() as session:
+        session.add(new_entry)
+
+    return CodeTailorParsonsValidator.from_orm(new_entry)
diff --git a/components/rsptx/db/models.py b/components/rsptx/db/models.py
diff --git a/components/rsptx/validation/schemas.py b/components/rsptx/validation/schemas.py
