${text}
`); - if (callback !== null) { - $("#import_rubric_popup_dialog").dialog({ buttons: { Ok: function() { $(this).dialog("close"); callback(); } } }); - } else { - $("#import_rubric_popup_dialog").dialog({ buttons: { Ok: function() { $(this).dialog("close"); } } }); - } - $("#import_rubric_popup_dialog").dialog("open"); + $("#import_rubric_popup_dialog").html(`${text}
`); + if (callback !== null) { + $("#import_rubric_popup_dialog").dialog({ + buttons: { + Ok: function () { + $(this).dialog("close"); + callback(); + }, + }, + }); + } else { + $("#import_rubric_popup_dialog").dialog({ + buttons: { + Ok: function () { + $(this).dialog("close"); + }, + }, + }); + } + $("#import_rubric_popup_dialog").dialog("open"); } function showProgress(amount) { - $("#import_rubric_bar").progressbar({ value: amount }); - $("#import_rubric_progress").dialog(); - if (amount === 100) { - $("#import_rubric_progress").dialog("close"); - } else { - $("#import_rubric_progress").dialog("open"); - } + $("#import_rubric_bar").progressbar({ value: amount }); + $("#import_rubric_progress").dialog(); + if (amount === 100) { + $("#import_rubric_progress").dialog("close"); + } else { + $("#import_rubric_progress").dialog("open"); + } } function getAssignId() { - const urlParams = window.location.href.split('?')[1].split('&'); - for (const param of urlParams) { - if (param.split('=')[0] === "assignment_id") { - return param.split('=')[1]; - } + const urlParams = window.location.href.split("?")[1].split("&"); + for (const param of urlParams) { + if (param.split("=")[0] === "assignment_id") { + return param.split("=")[1]; } + } } function getAllPages(url, callback) { - getRemainingPages(url, [], callback); + getRemainingPages(url, [], callback); } // Recursively work through paginated JSON list function getRemainingPages(nextUrl, listSoFar, callback) { - $.getJSON(nextUrl, function(responseList, textStatus, jqXHR) { - var nextLink = null; - $.each(jqXHR.getResponseHeader("link").split(','), function (linkIndex, linkEntry) { - if (linkEntry.split(';')[1].includes('rel="next"')) { - nextLink = linkEntry.split(';')[0].slice(1, -1); - } - }); - if (nextLink == null) { - // all pages have been retrieved - callback(listSoFar.concat(responseList)); - } else { - getRemainingPages(nextLink, listSoFar.concat(responseList), callback); + $.getJSON(nextUrl, function (responseList, textStatus, jqXHR) { + var nextLink = null; + $.each( + jqXHR.getResponseHeader("link").split(","), + function (linkIndex, linkEntry) { + if (linkEntry.split(";")[1].includes('rel="next"')) { + nextLink = linkEntry.split(";")[0].slice(1, -1); } - }); + } + ); + if (nextLink == null) { + // all pages have been retrieved + callback(listSoFar.concat(responseList)); + } else { + getRemainingPages(nextLink, listSoFar.concat(responseList), callback); + } + }); } // Send a list of requests in chunks of 10 to avoid rate limiting @@ -94,44 +115,46 @@ function getRemainingPages(nextUrl, listSoFar, callback) { // - request: The object for the jquery request // - error: The error message to display if the request fails function sendRequests(requests, successCallback, errorCallback) { - var errors = []; - var completed = 0; - var chunkSize = 10; - function sendChunk(i) { - $.each(requests.slice(i, i + chunkSize), function(i, request) { - $.ajax(request.request).fail(function(jqXHR, textStatus, errorThrown) { - errors.push(`${request.error}${jqXHR.status} - ${errorThrown}\n`); - }).always(requestSent); - }); - showProgress(i * 100 / requests.length); - if (i + chunkSize < requests.length) { - setTimeout(sendChunk, 1000, i + chunkSize); - } + var errors = []; + var completed = 0; + var chunkSize = 10; + function sendChunk(i) { + $.each(requests.slice(i, i + chunkSize), function (i, request) { + $.ajax(request.request) + .fail(function (jqXHR, textStatus, errorThrown) { + errors.push(`${request.error}${jqXHR.status} - ${errorThrown}\n`); + }) + .always(requestSent); + }); + showProgress((i * 100) / requests.length); + if (i + chunkSize < requests.length) { + setTimeout(sendChunk, 1000, i + chunkSize); } + } - // when each request finishes... - function requestSent() { - completed++; - if (completed >= requests.length) { - // all finished - showProgress(100); - if (errors.length > 0) { - errorCallback(errors); - } else { - successCallback(); - } - } + // when each request finishes... + function requestSent() { + completed++; + if (completed >= requests.length) { + // all finished + showProgress(100); + if (errors.length > 0) { + errorCallback(errors); + } else { + successCallback(); + } } - // actually starts the recursion - sendChunk(0); + } + // actually starts the recursion + sendChunk(0); } // Opens the main UI. // fileCallback should accept the file to validate along with a success callback that will be passed the import requests // importCallback should accept the list of score objects and actually perform the import function openImportDialog(fileCallback, importCallback) { - // build HTML - $("#import_rubric_dialog").html(` + // build HTML + $("#import_rubric_dialog").html(`Import a spreadsheet of rubric scores or ratings as grades for this assignment.
Ready to import scores for ${Object.keys(criteriaIds).length} criteria and ${outData.length} user(s).
`; - if (unmatchedCriteria.length) { - notice += `WARNING: These ${unmatchedCriteria.length} criteria could not be found in this assignment's rubric in Canvas and will be ignored:
${unmatchedCriteria.join('
')}.
WARNING: These ${doubledCriteria.length} criteria have both a rating and a points value given; the ratings will be ignored and auto-assigned by Canvas:
${doubledCriteria.join('
')}.
Note: "Posted Score" column will be ignored.
`; - } - if (outData.length < inData.length) { - notice += `Note: ${inData.length - outData.length} user(s) with a "null" Student ID will be ignored.
`; - } - $("#import_rubric_results").html(notice); - successCallback(scoreData); - } + criteriaIds[criterion] = id; } + } else { + unmatchedCriteria.push(criterion); + } }); - } + if (!Object.keys(criteriaIds).length) { + $("#import_rubric_results").text( + `No criteria listed in the file match those listed for this assignment's rubric in Canvas. Please double-check file format.` + ); + } else { + // Build list of score objects + function getRatingPoints(criterionId, ratingDesc) { + const criterion = assignment.rubric.find( + (i) => i.id === criterionId + ); + return criterion.ratings.find((i) => i.description === ratingDesc) + .points; + } + function getRatingObj(criterionId, ratingDesc) { + const criterion = assignment.rubric.find( + (i) => i.id === criterionId + ); + return criterion.ratings.find((i) => i.description === ratingDesc); + } + function getScores(row) { + let scores = { user: row["Student ID"] }; + $.each(criteriaIds, function (criterion, critId) { + // also map criteria ids each to an object giving the 'points' and possibly also the 'rating' + // You can't just give Canvas a rating, even though Canvas knows how many points it's worth: you must always specify points + if (`Points: ${criterion}` in row) { + // When points are specified, ignore the rating, which might contradict the points and cause an error + scores[critId] = { points: row[`Points: ${criterion}`] }; + } else { + // When the rating alone is specified, we still need to dig up how many points it should be worth, or it will error + const rating = getRatingObj( + critId, + row[`Rating: ${criterion}`] + ); + scores[critId] = rating + ? { points: rating.points, rating: rating.id } + : { error: String(row[`Rating: ${criterion}`]) }; + } + }); + return scores; + } + const scoreData = outData.map((i) => getScores(i)); + const badRows = scoreData.filter((i) => + Object.keys(i).find( + (j) => + j !== "user" && + "error" in i[j] && + i[j].error !== "undefined" && + i[j].error !== "" + ) + ); + if (badRows.length) { + let errors = []; + $.each(badRows.slice(0, 5), function (i, scoreObj) { + const badRating = + scoreObj[ + Object.keys(scoreObj).find( + (i) => i !== "user" && "error" in scoreObj[i] + ) + ].error; + errors.push( + `ERROR: Rating "${badRating}" given for user ${scoreObj.user} does not match a rating on this rubric in Canvas.` + ); + }); + let errTxt = errors.join("Ready to import scores for ${ + Object.keys(criteriaIds).length + } criteria and ${outData.length} user(s).
`; + if (unmatchedCriteria.length) { + notice += `WARNING: These ${
+ unmatchedCriteria.length
+ } criteria could not be found in this assignment's rubric in Canvas and will be ignored:
${unmatchedCriteria.join(
+ "
"
+ )}.
WARNING: These ${
+ doubledCriteria.length
+ } criteria have both a rating and a points value given; the ratings will be ignored and auto-assigned by Canvas:
${doubledCriteria.join(
+ "
"
+ )}.
Note: "Posted Score" column will be ignored.
`; + } + if (outData.length < inData.length) { + notice += `Note: ${ + inData.length - outData.length + } user(s) with a "null" Student ID will be ignored.
`; + } + $("#import_rubric_results").html(notice); + successCallback(scoreData); + } + } + } + ); + } } // Actually import the data user by user // scores is a list of objects with properties: -// - user: The SIS User ID +// - user: The SIS User ID or Canvas user ID, depending on endpoint used // - plus any number of criteria ids mapped each to an object with property 'points' and optionally 'rating' function importScores(scores) { - $("#import_rubric_file").val(''); - const courseId = window.location.href.split('/')[4]; - const assignId = getAssignId(); + $("#import_rubric_file").val(""); + const courseId = window.location.href.split("/")[4]; + const assignId = getAssignId(); - // When each request is prepared, add it to the list - // When the list is complete, send them off - var requests = []; - const total = scores.length; - function pushRequest(request) { - requests.push(request); - if (requests.length === total) { - sendRequests( - requests, - function() { popUp("All scores/ratings imported successfully!", function() { location.reload(); }); }, - function(errors) { - saveText(errors, "errors.txt"); - popUp(`Import complete. WARNING: ${errors.length} rows failed to import. See errors.txt for details.`, function() { location.reload(); }); - }); + // When each request is prepared, add it to the list + // When the list is complete, send them off + var requests = []; + const total = scores.length; + function pushRequest(request) { + requests.push(request); + if (requests.length === total) { + sendRequests( + requests, + function () { + popUp("All scores/ratings imported successfully!", function () { + location.reload(); + }); + }, + function (errors) { + saveText(errors, "errors.txt"); + popUp( + `Import complete. WARNING: ${errors.length} rows failed to import. See errors.txt for details.`, + function () { + location.reload(); + } + ); } + ); } + } - // Build each request by recursively iterating through scores to ensure GETs are sent one chunk at a time - const chunkSize = 10; - function buildRequests(chunkIndex) { - $.each(scores.slice(chunkIndex, chunkIndex + chunkSize), function(index, userScore) { - const endpoint = `/api/v1/courses/${courseId}/assignments/${assignId}/submissions/sis_user_id:${userScore.user}`; - // Get existing rubric assessment from the submissions API - // This allows us to ensure that existing data like comments aren't overwritten - $.getJSON(`${endpoint}?include[]=rubric_assessment`, function(submission) { - // Pre-load params with existing rubric assessment data - var params = {}; - if (submission.rubric_assessment) { - $.each(submission.rubric_assessment, function(rowKey, rowValue) { - $.each(rowValue, function(cellKey, cellValue) { - params[`rubric_assessment[${rowKey}][${cellKey}]`] = cellValue; - }); - // Make sure the comments param is never left out or undefined; Canvas can't handle this - if (!(`rubric_assessment[${rowKey}][comments]` in params) || params[`rubric_assessment[${rowKey}][comments]`] === undefined) { - params[`rubric_assessment[${rowKey}][comments]`] = ""; - } - }); - } - // Now fill in our points or ratings to be applied - $.each(userScore, function(critId, critScore) { - if (critId !== 'user') { - if ('error' in critScore) { - // These are "undefined" ratings, in which case we'll just clear the rating and score; - params[`rubric_assessment[${critId}][points]`] = undefined; - params[`rubric_assessment[${critId}][rating_id]`] = undefined; - } else { - params[`rubric_assessment[${critId}][points]`] = critScore.points; - if ('rating' in critScore) { - params[`rubric_assessment[${critId}][rating_id]`] = critScore.rating; - } else { - delete params[`rubric_assessment[${critId}][rating_id]`]; - } - } - // Again, ensure we don't leave out the comments field - if (!(`rubric_assessment[${critId}][comments]` in params)) { - params[`rubric_assessment[${critId}][comments]`] = ""; - } - } + // Build each request by recursively iterating through scores to ensure GETs are sent one chunk at a time + const chunkSize = 10; + function buildRequests(chunkIndex) { + $.each( + scores.slice(chunkIndex, chunkIndex + chunkSize), + function (index, userScore) { + // can use /${userScore.user} if account does not use SIS + const endpoint = `/api/v1/courses/${courseId}/assignments/${assignId}/submissions/sis_user_id:${userScore.user}`; + // Get existing rubric assessment from the submissions API + // This allows us to ensure that existing data like comments aren't overwritten + $.getJSON( + `${endpoint}?include[]=rubric_assessment`, + function (submission) { + // Pre-load params with existing rubric assessment data + var params = {}; + if (submission.rubric_assessment) { + $.each(submission.rubric_assessment, function (rowKey, rowValue) { + $.each(rowValue, function (cellKey, cellValue) { + params[`rubric_assessment[${rowKey}][${cellKey}]`] = + cellValue; }); - pushRequest({request: {url: endpoint, - type: "PUT", - data: params, - dataType: "text" }, - error: `Failed to import scores for student ${userScore.user} using endpoint ${endpoint}. Response: `}); + // Make sure the comments param is never left out or undefined; Canvas can't handle this + if ( + !(`rubric_assessment[${rowKey}][comments]` in params) || + params[`rubric_assessment[${rowKey}][comments]`] === undefined + ) { + params[`rubric_assessment[${rowKey}][comments]`] = ""; + } + }); + } + // Now fill in our points or ratings to be applied + $.each(userScore, function (critId, critScore) { + if (critId !== "user") { + if ("error" in critScore) { + // These are "undefined" ratings, in which case we'll just clear the rating and score; + params[`rubric_assessment[${critId}][points]`] = undefined; + params[`rubric_assessment[${critId}][rating_id]`] = undefined; + } else { + params[`rubric_assessment[${critId}][points]`] = + critScore.points; + if ("rating" in critScore) { + params[`rubric_assessment[${critId}][rating_id]`] = + critScore.rating; + } else { + delete params[`rubric_assessment[${critId}][rating_id]`]; + } + } + // Again, ensure we don't leave out the comments field + if (!(`rubric_assessment[${critId}][comments]` in params)) { + params[`rubric_assessment[${critId}][comments]`] = ""; + } + } }); - }); - if (chunkIndex + chunkSize < scores.length) { - setTimeout(buildRequests, 1000, chunkIndex + chunkSize); - } + pushRequest({ + request: { + url: endpoint, + type: "PUT", + data: params, + dataType: "text", + headers: { + Authorization: `Bearer ${canvasToken}`, + "Content-Type": "application/x-www-form-urlencoded", + }, + }, + error: `Failed to import scores for student ${userScore.user} using endpoint ${endpoint}. Response: `, + }); + } + ); + } + ); + if (chunkIndex + chunkSize < scores.length) { + setTimeout(buildRequests, 1000, chunkIndex + chunkSize); } - // Start recursive iteration - buildRequests(0); + } + // Start recursive iteration + buildRequests(0); } -defer(function() { - 'use strict'; +defer(function () { + "use strict"; - // Only add the import button if a rubric is appearing - if ($('#rubric_summary_holder').length > 0) { - $("body").append($('')); - $("body").append($('')); - $("body").append($('Importing rubric scores. Do not navigate from this page.
Importing rubric scores. Do not navigate from this page.