-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
578 lines (501 loc) · 16.4 KB
/
index.js
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
// imports
import path from 'path';
import fs from 'fs';
import * as Service from './service.js';
import * as Common from './lib/common.js';
import CONFIG from './config.js';
// constants
const PROBE_SCREEN = true;
const callId = () => (99999*Math.random()+Date.now()).toString(36);
const {sleep, DEBUG, DEBUG2} = Common;
// simple key value store
const KV = {};
const HasListeners = new Map();
// main export
// note that these calls with UI = App.UI
// will run against the default (the first) UI created.
// but only when called directly from the service side.
// when called from UI side, the calls that have a UI parameter
// are called on the UI that makes the call or, if the UI parameter is a string
// called on the UI having the name equal to that string.
// before the App opens a window or
// if the 'default' UI is closed there will be no default UI
// and calls made from the service side on functions
// requiring a UI parameter and without specifying a UI
// parameter will fail at that time
// until a new UI (window) is opened (via API.ui.open())
const API = {
go, // start app launch sequence
stop, // kill app, cleanup, and exit (after async jobs parameter completes)
say, // say something to console (throws if console closed)
ui : {
open, // open UI window
close, // close UI window
move, // move UI window (throws if no window open)
size, // size UI window (throws if no window open)
minimize, // minimize UI window (throws if no window open)
maximize, // maximize UI window (throws if no window open)
restore, // switch between maximize and how it was before
fullscreen, // UI window to fullscreen
partscreen, // UI window to part of screen
getLayout, // get window left, right, width, height and windowState
openBlank, // open a UI window to about:blank
writePage, // like document.write if using a custom window control box, writes to the
// iframe document inside that
getScreen, // get screen dimensions
},
meta: {
getStartURL, // gets the start URL for the app
getFavicon, // gets a (or an optionally named) favicon as a data URL
getTitle, // gets the app title
},
control: {
send, // send a DevTools command (throws if ui not connected yet)
on, // start listening for a DevTools event (throws if ui not connected yet)
off, // stop listening for a DevTools event (throws if ui not connected yet)
},
util: {
sleep,
kv: save, // save a (key, value) pair
k: load, // getrieve a key
d: del,
hasKey // returns a promise that resolves when a key is set
},
_serviceOnly: {
publishAPI, // publish an API into the UI context (requires apiInUI: true)
getUI,
getApp
}
};
export default API;
// state variables
let App;
// basic functions
async function go({
uiName:
uiName = undefined, // name for first window opened (if any)
apiInUI: // enable grader API available in UI context
apiInUI = false,
addHandlers:
addHandlers = undefined, // callback to add the route handlers to an express app
server:
server = null, // used to replace the default server
// if you don't want a server or if you need
// more control (such as websockets, or TLS)
// we call listen automatically
keepConsoleOpen:
keepConsoleOpen = false, // keeps the console open in case you need it
doLayout:
doLayout = true, // control window layout on screen
// true for auto centered mode (default) or
// a function with signature: ({screenWidth, screenHeight}) =>
// {screenWidth, screenHeight, x, y, width, height}
// to set the x,y,width,height base on screenWidth and screenHeight
keepAlive:
keepAlive = false, // keeps the service running after all windows closed
// until it is explicitly killed with stop
noWindow:
noWindow = false, // starts the service but doesn't open a window
} = {}) {
App = await Service.go({
uiName,
apiInUI, addHandlers,
server, keepConsoleOpen, doLayout, keepAlive, noWindow
});
return App;
}
async function stop() {
if ( !App ) {
throw new TypeError(
`API.stop can only be called if App has started and is not already stopped.`
);
}
await App.killService();
}
async function say(msg) {
try {
await App.notify(msg);
} catch(e) {
DEBUG && console.info("say.App.notify", e);
throw new TypeError(
`Cannot API.say a console message because App Console has already closed.`
);
}
}
// window functions
async function open(settings) {
if ( ! App ) throw new TypeError(`Need to call API.go first to create App before opening additional windows.`);
const {uis,ServicePort} = App;
const {uiName: name, keepService, uriPath} = settings;
const sessionId = Common.newSessionId();
// do layout prep if requrested
let layout;
if ( settings.doLayout ) {
let screenWidth, screenHeight;
if ( PROBE_SCREEN ) {
({screenWidth, screenHeight} = await getScreen({
ServicePort,
/*
sessionId,
*/
uis
}));
} else {
screenWidth = 800;
screenHeight = 600;
}
layout = {screenWidth, screenHeight};
if ( typeof settings.doLayout === "function" ) {
layout = settings.doLayout(layout);
}
}
fs.writeFileSync('grader.open.log', JSON.stringify({ServicePort, sessionId}));
let browser, UI;
try {
({UI,browser} = await Service.newBrowser({
uis,
ServicePort, sessionId, layout, name,
keepService,
uriPath
}));
// if not UI yet, this is the first so set it as default
if ( ! App.UI ) {
App.UI = UI;
}
} catch(e) {
console.log("open.newBrowser", e);
fs.writeFileSync('grader.error', JSON.stringify({err:e, msg:e+''}));
}
// don't expose socket
UI.socket = null;
return {UI,browser};
}
async function close(UI = App.UI) {
const call = callId();
const {browserSessionId,id} = UI;
DEBUG2 && console.info({browserSessionId,id,call,close:1});
const errors = [];
if ( ! UI.disconnected ) {
try {
DEBUG2 && console.info({browserSessionId,id,call,close:2});
await UI.send("Browser.close", {});
DEBUG2 && console.info({browserSessionId,id,call,close:3});
} catch(e) {
DEBUG2 && console.info('Error closing browser', e);
errors.push({msg:'error closing browser', e});
}
try {
DEBUG2 && console.info({browserSessionId,id,call,close:4});
UI.disconnect();
DEBUG2 && console.info({browserSessionId,id,call,close:5});
} catch(e) {
DEBUG2 && console.info(`Error disconnecting socket`, e);
errors.push({msg:'error disconnecting socket', e});
}
}
// does not work
//await sleep(1000);
try {
await UI.browser.kill();
} catch(e) {
DEBUG2 && console.info(`Error kill browser`, e);
errors.push({msg:'error kill browser', e});
}
try {
DEBUG2 && console.info({browserSessionId,id,call,close:6});
UI.cleanSessionDirs();
DEBUG2 && console.info({browserSessionId,id,call,close:7});
} catch(e) {
DEBUG2 && console.info(`Error shut down browser.`, e);
errors.push({msg:'error UI.cleanSessionDirs', e});
}
DEBUG2 && console.info({browserSessionId,id,call,close:8});
if ( errors.length ) {
DEBUG2 && console.log(`API.ui.close`, errors);
return {status:'fail', errors};
} else {
DEBUG2 && console.log(`API.ui.close`, 'success');
return {status:'success'};
}
}
async function move({x,y}, UI = App.UI) {
UI.x = x;
UI.y = y;
return await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
left: x,
top: y
}
});
}
async function size({width,height}, UI = App.UI) {
/*
await UI.send("Emulation.setDeviceMetricsOverride", {
mobile: false,
width,
height,
deviceScaleFactor: 1,
screenOrientation: {
angle: 0,
type: 'portraitPrimary'
},
});
*/
await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'normal',
width:0,
height:0
}
});
const result = await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'normal',
width,
height
}
});
UI.width = width;
UI.height = height;
return result;
}
async function minimize(UI = App.UI) {
const {windowState} = await getLayout();
if ( windowState == 'minimized' ) return;
const result = await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'minimized'
}
});
return result;
}
async function restore(UI = App.UI) {
const {windowState} = await getLayout();
let result;
if ( windowState == 'maximized' ) {
result = await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'normal'
}
});
} else {
result = await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'maximized'
}
});
}
return result;
}
async function maximize(UI = App.UI) {
const {windowState} = await getLayout();
if ( windowState == 'minimized' ) {
await partscreen(UI);
}
const result = await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'maximized'
}
});
return result;
}
async function fullscreen(UI = App.UI) {
const {windowState} = await getLayout();
if ( windowState == 'minimized' ) {
await partscreen(UI);
}
const result = await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'fullscreen'
}
});
return result;
}
async function partscreen(UI = App.UI) {
const {windowState} = await getLayout();
if ( windowState == 'normal' ) return;
const result = await UI.send("Browser.setWindowBounds", {
windowId: UI.windowId,
bounds: {
windowState: 'normal'
}
});
return result;
}
async function getLayout(UI = App.UI) {
const {bounds} = await UI.send("Browser.getWindowBounds", {
windowId: UI.windowId
});
return bounds;
}
// window functions part ii
async function openBlank() {
throw new TypeError(`Not implemented yet.`);
}
async function writePage() {
throw new TypeError(`Not implemented yet.`);
}
// meta functions
async function getStartURL(UI = App.UI) {
return UI.startUrl;
}
async function getFavicon() {
const iconPath = path.resolve(Service.SITE_PATH, '_icons', 'favicon.ico');
const base64Icon = fs.readFileSync(iconPath, {encoding:'base64'});
const dataURL = `data:image/ico;base64,${base64Icon}`;
return dataURL;
}
async function getTitle() {
return CONFIG.name;
}
// window functions part iii
async function getScreen({ServicePort, sessionId: providedSessionId, uis} = {}) {
console.log(`Getting screen`);
let screen = load('screen');
if ( !screen ) {
// open a headless browser to a page that sends us the screen details
let UI;
try {
({UI} = await Service.newBrowser({
uis,
silent: true,
headless: true,
uriPath: '/_api/getscreen.html',
ServicePort,
sessionId: providedSessionId || Common.newSessionId(),
// we will delete directories unless provided with a sessionId
// which can save time for main UI startup as the headless
// window prepares all the session directories
noDelete: providedSessionId ? true : false,
// we don't want to kill the whole service when we close this UI
// and we have no other UIs open
// since often this UI comes before others to provide the screen details
// for layout
keepService: true
}));
} catch(e) {
console.log("getScreen.newBrowser", e);
fs.writeFileSync('grader.error', JSON.stringify({err:e, msg:e+''}));
}
// wait until the key is set
await hasKey('screen');
// kill the browser __ it has served its purpose, honorably and nobly
await close(UI);
screen = load('screen');
}
console.log({screen});
return screen;
}
// control functions
async function send(command, params, UI = App.UI) {
return await UI.send(command, params);
}
async function on(eventName, handler, UI = App.UI) {
return await UI.on(eventName, handler);
}
function off() {
throw new TypeError(`off is not implemented yet...`);
}
// util part i: KV functions (keys are strings)
function save(key, value) {
DEBUG && console.log({save:{key,value}});
key += '';
if ( typeof value == "object" ) {
// do a pseudo merge
let newValue;
if ( Array.isArray(value) ) {
const existing = KV[key] || [];
if ( Array.isArray(existing) ) {
newValue = [...existing, ...value];
} else if ( typeof existing == "object" ) {
value.forEach((v,i) => {
existing[i] = v;
});
newValue = existing;
} else {
newValue = value;
}
} else {
const existing = KV[key] || {};
newValue = Object.assign(existing, value);
}
KV[key] = newValue;
} else {
KV[key] = value;
}
// run any listeners waiting for this key to be set
let listeners = HasListeners.get(key);
if ( listeners ) {
HasListeners.delete(key);
listeners.forEach(res => {
// execute each without a stack
setTimeout(() => res(true), 0);
});
}
}
function load(key) {
key += '';
return KV[key];
}
function del(key) {
key += '';
delete KV[key];
}
// returns a promise that resolves to true when the key is set
async function hasKey(key) {
key += '';
let resolve;
const pr = new Promise(res => resolve = res);
let hasKey = false;
hasKey = Object.prototype.hasOwnProperty.call(KV, key);
if ( hasKey ) {
return resolve(true);
} else {
let listeners = HasListeners.get(key);
if ( ! listeners ) {
listeners = [];
HasListeners.set(key, listeners);
}
// these listeners will be called by save once key is set
listeners.push(resolve);
}
return pr;
}
// service only functions (not available over the API bridge to UI)
function publishAPI(apiRoot, slotName) {
// apiRoot is an object with properties that enumerate all the functions of that API
// e.g. if your API is "sendEmail", "checkReplies", your apiRoot is
// {sendEmail, checkReplies}
// you can overwrite built-in APIs (like uitl, ui, control and window)
// but we throw if you try to overwrite those APIs you publish
Object.defineProperty(API, slotName, {
get: () => apiRoot,
set() {
throw new TypeError(`API slot ${slotName} is already present and cannot be overwritten.`);
}
});
}
function getUI(name) {
if ( ! App ) {
throw new TypeError(`Cannot call getUI when App does not exist.`);
}
if ( App.uis.has(name) ) {
return App.uis.get(name);
} else {
throw new TypeError(`UI with name ${name} does not exist.`);
}
}
function getApp() {
if ( ! App ) {
throw new TypeError(`Cannot call getApp when App does not exist.`);
}
return App;
}