/
localturk.ts
205 lines (181 loc) · 6.08 KB
/
localturk.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
#!/usr/bin/env node
/**
* "Local Turk" server for running Mechanical Turk-like tasks locally.
*
* Usage:
*
* localturk [--options] template.html tasks.csv outputs.csv
*/
import * as bodyParser from 'body-parser';
import * as errorhandler from 'errorhandler';
import * as express from 'express';
import * as fs from 'fs-extra';
import * as path from 'path';
import * as program from 'commander';
import open = require('open');
import Reservoir = require('reservoir');
import * as _ from 'lodash';
import * as csv from './csv';
import {makeTemplate} from './sample-template';
import * as utils from './utils';
import { outputFile } from 'fs-extra';
program
.version('2.1.1')
.usage('[options] template.html tasks.csv outputs.csv')
.option('-p, --port <n>', 'Run on this port (default 4321)', parseInt)
.option('-s, --static-dir <dir>',
'Serve static content from this directory. Default is same directory as template file.')
.option('-r, --random-order',
'Serve images in random order, rather than sequentially. This is useful for ' +
'generating valid subsamples or for minimizing collisions during group localturking.')
.option('-w, --write-template', 'Generate a stub template file based on the input CSV.')
.parse(process.argv);
const {args, randomOrder, writeTemplate} = program;
if (!((3 === args.length && !writeTemplate) ||
(1 === args.length && writeTemplate))) {
program.help();
}
if (writeTemplate) {
// tasks.csv is the only input with --write-template.
args.unshift('');
args.push('');
}
const [templateFile, tasksFile, outputsFile] = args;
const port = program.port || 4321;
// --static-dir is particularly useful for classify-images, where the template file is in a
// temporary directory but the image files could be anywhere.
const staticDir = program['staticDir'] || path.dirname(templateFile);
type Task = {[key: string]: string};
let flash = ''; // this is used to show warnings in the web UI.
async function renderTemplate({task, numCompleted, numTotal}: TaskStats) {
const template = await fs.readFile(templateFile, {encoding: 'utf8'});
const fullDict = {};
for (const k in task) {
fullDict[k] = utils.htmlEntities(task[k]);
}
// Note: these two fields are not available in mechanical turk.
fullDict['ALL_JSON'] = utils.htmlEntities(JSON.stringify(task, null, 2));
fullDict['ALL_JSON_RAW'] = JSON.stringify(task);
const userHtml = utils.renderTemplate(template, fullDict);
const thisFlash = flash;
flash = '';
const sourceInputs = _.map(task, (v, k) =>
`<input type=hidden name="${k}" value="${utils.htmlEntities(v)}">`
).join('\n');
return utils.dedent`
<!doctype html>
<html>
<title>${numCompleted} / ${numTotal} - localturk</title>
<body><form action=/submit method=post>
<p>${numCompleted} / ${numTotal} <span style="background: yellow">${thisFlash}</span></p>
${sourceInputs}
${userHtml}
<hr/><input type=submit />
</form>
<script>
// Support keyboard shortcuts via, e.g. <.. data-key="1" />
window.addEventListener("keydown", function(e) {
if (document.activeElement !== document.body) return;
var key = e.key;
const el = document.querySelector('[data-key="' + key + '"]');
if (el) {
e.preventDefault();
el.click();
}
});
</script>
</body>
</html>
`;
}
async function readCompletedTasks(): Promise<Task[]> {
if (!fs.pathExistsSync(outputsFile)) return [];
return csv.readAllRowObjects(outputsFile);
}
function isTaskCompleted(task, completedTasks) {
const normTask = utils.normalizeValues(task);
for (const d of completedTasks) {
if (utils.isSupersetOf(d, normTask)) return true;
}
return false;
}
async function checkTaskOutput(task: Task) {
// Check whether the output has any keys that aren't in the input.
// This is a common mistake that can happen if you forget to set a name on
// your form elements.
const headers = await csv.readHeaders(tasksFile);
for (const k in task) {
if (headers.indexOf(k) === -1) return; // there's a new key.
}
flash = 'No new keys in output. Make sure your <input> elements have "name" attributes';
}
interface TaskStats {
task?: Task;
numCompleted: number;
numTotal: number;
}
async function getNextTask(): Promise<TaskStats> {
const completedTasks = (await readCompletedTasks()).map(utils.normalizeValues);
let sampler = randomOrder ? Reservoir<Task>() : null;
let nextTask: Task;
let numTotal = 0;
for await (const task of csv.readRowObjects(tasksFile)) {
numTotal++;
if (!sampler && nextTask) {
continue; // we're only counting at this point.
}
if (isTaskCompleted(utils.normalizeValues(task), completedTasks)) {
continue;
}
if (sampler) {
sampler.pushSome(task);
} else {
nextTask = task;
}
}
return {
task: sampler ? sampler[0] : nextTask,
numCompleted: _.size(completedTasks),
numTotal,
}
}
const app = express();
app.use(bodyParser.urlencoded({extended: false}));
app.use(errorhandler());
app.use(express.static(path.resolve(staticDir)));
app.get('/', utils.wrapPromise(async (req, res) => {
const nextTask = await getNextTask();
if (nextTask.task) {
console.log(nextTask.task);
const html = await renderTemplate(nextTask);
res.send(html);
} else {
res.send('DONE');
process.exit(0);
}
}));
app.post('/submit', utils.wrapPromise(async (req, res) => {
const task: Task = req.body;
await csv.appendRow(outputsFile, task);
checkTaskOutput(task); // sets the "flash" variable with any errors.
console.log('Saved ' + JSON.stringify(task));
res.redirect('/');
}));
app.post('/delete-last', utils.wrapPromise(async (req, res) => {
const row = await csv.deleteLastRow(outputsFile);
console.log('Deleting', row);
res.redirect('/');
}));
if (writeTemplate) {
(async () => {
const columns = await csv.readHeaders(tasksFile);
console.log(makeTemplate(columns));
})().catch(e => {
console.error(e);
});
} else {
app.listen(port);
const url = `http://localhost:${port}`;
console.log('Running local turk on', url);
open(url);
}