HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-12 16:48:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

TS-ify turk module, incorporate #1563 fix

Browse Source
This commit is contained in:
Josh de Leeuw 2021-09-01 13:19:12 -04:00
parent ab7b3545cf
commit 898a38d3a7
1 changed files with 71 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
packages/jspsych/src/modules/turk.ts
View File

@ -1,20 +1,58 @@
// core.turkInfo gets information relevant to mechanical turk experiments. returns an object interface turkInformation {
// containing the workerID, assignmentID, and hitID, and whether or not the HIT is in /**
// preview mode, meaning that they haven't accepted the HIT yet. * Is the experiment being loaded in preview mode on Mechanical Turk?
export function turkInfo() { */
var turk = <any>{}; previewMode: boolean;
/**
* Is the experiment being loaded outside of the Mechanical Turk environment?
*/
outsideTurk: boolean;
/**
* The HIT ID.
*/
hitId: string;
/**
* The Assignment ID.
*/
assignmentId: string;
/**
* The worker ID.
*/
workerId: string;
/**
* URL for submission of the HIT.
*/
turkSubmitTo: string;
}
var param = function (url, name) { /**
* Gets information about the Mechanical Turk Environment, HIT, Assignment, and Worker
* by parsing the URL variables that Mechanical Turk generates.
* @returns An object containing information about the Mechanical Turk Environment, HIT, Assignment, and Worker.
*/
export function turkInfo(): turkInformation {
const turk: turkInformation = {
previewMode: false,
outsideTurk: false,
hitId: "INVALID_URL_PARAMETER",
assignmentId: "INVALID_URL_PARAMETER",
workerId: "INVALID_URL_PARAMETER",
turkSubmitTo: "INVALID_URL_PARAMETER",
};
const param = function (url, name) {
name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]"); name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
var regexS = "[\\?&]" + name + "=([^&#]*)"; const regexS = "[\\?&]" + name + "=([^&#]*)";
var regex = new RegExp(regexS); const regex = new RegExp(regexS);
var results = regex.exec(url); const results = regex.exec(url);
return results == null ? "" : results[1]; return results == null ? "" : results[1];
}; };
var src = param(window.location.href, "assignmentId") ? window.location.href : document.referrer; const src = param(window.location.href, "assignmentId")
? window.location.href
: document.referrer;
var keys = ["assignmentId", "hitId", "workerId", "turkSubmitTo"]; const keys = ["assignmentId", "hitId", "workerId", "turkSubmitTo"];
keys.map(function (key) { keys.map(function (key) {
turk[key] = unescape(param(src, key)); turk[key] = unescape(param(src, key));
}); });
@ -24,31 +62,38 @@ export function turkInfo() {
turk.outsideTurk = turk.outsideTurk =
!turk.previewMode && turk.hitId === "" && turk.assignmentId == "" && turk.workerId == ""; !turk.previewMode && turk.hitId === "" && turk.assignmentId == "" && turk.workerId == "";
// TODO Was this intended to set a global variable?
// turk_info = turk;
return turk; return turk;
} }
// core.submitToTurk will submit a MechanicalTurk ExternalHIT type /**
* Send data to Mechnical Turk for storage.
* @param data An object containing `key:value` pairs to send to Mechanical Turk. Values
* cannot contain nested objects, arrays, or functions.
* @returns Nothing
*/
export function submitToTurk(data) { export function submitToTurk(data) {
var turkInfo = turkInfo(); const turk = turkInfo();
var assignmentId = turkInfo.assignmentId; const assignmentId = turk.assignmentId;
var turkSubmitTo = turkInfo.turkSubmitTo; const turkSubmitTo = turk.turkSubmitTo;
if (!assignmentId || !turkSubmitTo) return; if (!assignmentId || !turkSubmitTo) return;
var dataString = []; const form = document.createElement("form");
form.method = "POST";
form.action = turkSubmitTo + "/mturk/externalSubmit?assignmentId=" + assignmentId;
for (var key in data) { for (const key in data) {
if (data.hasOwnProperty(key)) { if (data.hasOwnProperty(key)) {
dataString.push(key + "=" + escape(data[key])); const hiddenField = document.createElement("input");
hiddenField.type = "hidden";
hiddenField.name = key;
hiddenField.id = key;
hiddenField.value = data[key];
form.appendChild(hiddenField);
} }
} }
dataString.push("assignmentId=" + assignmentId); document.body.appendChild(form);
form.submit();
var url = turkSubmitTo + "/mturk/externalSubmit?" + dataString.join("&");
window.location.href = url;
} }