runtime/Debugger.js · elk · git.iko.soy

git.iko.soy/elk

on 71fa066 help sign in

elk/runtime/Debugger.js

609 lines 17 kB history raw

1(function() {

2'use strict';

4if (!window.location.origin) {

5 window.location.origin =

6 window.location.protocol + "//" +

7 window.location.hostname +

8 (window.location.port ? (':' + window.location.port) : '');

9}

11Elm.Debugger = null;

12Elm.debuggerAttach = function(module, hotSwapState /* =undefined */) {

13 return {

14 make: function(runtime) {

15 var wrappedModule = debugModule(module, runtime);

16 Elm.Debugger = debuggerInit(wrappedModule, runtime, hotSwapState);

17 dispatchElmDebuggerInit();

18 return wrappedModule.debuggedModule;

19 }

20 };

21};

23var EVENTS_PER_SAVE = 100;

25function dispatchElmDebuggerInit() {

26 if (parent.window) {

27 var dispatch = function() {

28 parent.window.postMessage("elmDebuggerInit", window.location.origin);

29 };

30 if (parent.window.document.readyState === "complete") {

31 dispatch();

32 }

33 else {

34 parent.window.addEventListener("load", dispatch);

35 }

36 }

39function debugModule(module, runtime) {

40 var programPaused = false;

41 var recordedEvents = [];

42 var asyncCallbacks = [];

43 var snapshots = [];

44 var watchTracker = Elm.Native.Debug.make(runtime).watchTracker;

45 var pauseTime = 0;

46 var eventsUntilSnapshot = EVENTS_PER_SAVE;

47 runtime.debuggerStatus = runtime.debuggerStatus || {};

48 runtime.debuggerStatus.eventCounter = runtime.debuggerStatus.eventCounter || 0;

50 // runtime is the prototype of wrappedRuntime

51 // so we can access all runtime properties too

52 var wrappedRuntime = Object.create(runtime);

53 wrappedRuntime.notify = wrapNotify;

54 wrappedRuntime.runDelayed = wrapRunDelayed;

56 // make a copy of the wrappedRuntime

57 var assignedPropTracker = Object.create(wrappedRuntime);

58 var debuggedModule = module.make(assignedPropTracker);

60 // make sure the signal graph is actually a signal & extract the visual model

61 if ( !('recv' in debuggedModule.main) ) {

62 debuggedModule.main = Elm.Signal.make(runtime).constant(debuggedModule.main);

63 }

65 // The main module stores imported modules onto the runtime.

66 // To ensure only one instance of each module is created,

67 // we assign them back on the original runtime object.

68 Object.keys(assignedPropTracker).forEach(function(key) {

69 runtime[key] = assignedPropTracker[key];

70 });

72 var signalGraphNodes = flattenSignalGraph(wrappedRuntime.inputs);

73 var tracePath = tracePathInit(runtime, debuggedModule.main);

75 snapshots.push(snapshotSignalGraph(signalGraphNodes));

77 function wrapNotify(id, v) {

78 var timestep = runtime.timer.now();

80 if (programPaused) {

81 // ignore async events generated while playing back

82 // or user events while program is paused

83 return false;

84 }

85 else {

86 recordEvent(id, v, timestep);

87 var changed = runtime.notify(id, v, timestep);

88 snapshotOnCheckpoint();

89 if (parent.window) {

90 parent.window.postMessage("elmNotify", window.location.origin);

91 }

92 return changed;

93 }

94 };

96 function wrapRunDelayed(func, delayMs) {

97 if (programPaused) {

98 // Don't push timers and such to the callback stack while we're paused.

99 // It causes too many callbacks to be fired during unpausing.

100 return 0;

101 }

102 var cbObj = { func:func, delayMs:delayMs, timerId:0, executed:false };

103 var timerId = setTimeout(function() {

104 cbObj.executed = true;

105 func();

106 }, delayMs);

107 cbObj.timerId = timerId;

108 asyncCallbacks.push(cbObj);

109 return timerId;

110 }

112 function recordEvent(id, v, timestep) {

113 watchTracker.pushFrame();

114 recordedEvents.push({ id:id, value:v, timestep:timestep });

115 runtime.debuggerStatus.eventCounter += 1;

116 }

118 function clearAsyncCallbacks() {

119 asyncCallbacks.forEach(function(timer) {

120 if (!timer.executed) {

121 clearTimeout(timer.timerId);

122 }

123 });

124 }

126 function clearRecordedEvents() {

127 recordedEvents = [];

128 runtime.debuggerStatus.eventCounter = 0;

129 }

131 function getRecordedEventsLength() {

132 return recordedEvents.length;

133 }

135 function getRecordedEventAt(i) {

136 return recordedEvents[i];

137 }

139 function copyRecordedEvents() {

140 return recordedEvents.slice();

141 }

143 function loadRecordedEvents(events) {

144 recordedEvents = events.slice();

145 }

147 function clearSnapshots() {

148 snapshots = [snapshotSignalGraph(signalGraphNodes)];

149 }

151 function getSnapshotAt(i) {

152 var snapshotEvent = Math.floor(i / EVENTS_PER_SAVE);

153 assert(snapshotEvent < snapshots.length && snapshotEvent >= 0,

154 "Out of bounds index: " + snapshotEvent);

155 return snapshots[snapshotEvent];

156 }

158 function snapshotOnCheckpoint() {

159 if (eventsUntilSnapshot === 1) {

160 snapshots.push(snapshotSignalGraph(signalGraphNodes));

161 eventsUntilSnapshot = EVENTS_PER_SAVE;

162 } else {

163 eventsUntilSnapshot -= 1;

164 }

165 }

167 function setPaused() {

168 programPaused = true;

169 clearAsyncCallbacks();

170 pauseTime = Date.now();

171 tracePath.stopRecording();

172 preventInputEvents();

173 }

175 function setContinue(position) {

176 var pauseDelay = Date.now() - pauseTime;

177 runtime.timer.addDelay(pauseDelay);

178 programPaused = false;

180 // we need to dump the events that are ahead of where we're continuing.

181 var lastSnapshotPosition = Math.floor(position / EVENTS_PER_SAVE);

182 eventsUntilSnapshot = EVENTS_PER_SAVE - (position % EVENTS_PER_SAVE);

183 snapshots = snapshots.slice(0, lastSnapshotPosition + 1);

185 if (position < getRecordedEventsLength()) {

186 var lastEventTime = recordedEvents[position].timestep;

187 var scrubTime = runtime.timer.now() - lastEventTime;

188 runtime.timer.addDelay(scrubTime);

189 }

191 recordedEvents = recordedEvents.slice(0, position);

192 tracePath.clearTracesAfter(position);

193 runtime.debuggerStatus.eventCounter = position;

194 executeCallbacks(asyncCallbacks);

195 permitInputEvents();

197 tracePath.startRecording();

198 }

200 function getPaused() {

201 return programPaused;

202 }

204 function preventInputEvents(){

205 var events =

206 [ "click", "mousemove", "mouseup", "mousedown", "mouseclick"

207 , "keydown", "keypress", "keyup", "touchstart", "touchend"

208 , "touchcancel", "touchleave", "touchmove", "pointermove"

209 , "pointerdown", "pointerup", "pointerover", "pointerout"

210 , "pointerenter", "pointerleave", "pointercancel"

211 ];

213 var ignore = function(e) {

214 var evt = e ? e : window.event;

215 if (evt.stopPropagation) {

216 evt.stopPropagation();

217 }

218 if (evt.cabcelBubble !== null) {

219 evt.cabcelBubble = true;

220 }

221 if (evt.preventDefault) {

222 evt.preventDefault();

223 }

224 return false;

225 };

227 var ignoringDiv = document.getElementById("elmEventIgnorer");

228 if (!ignoringDiv) {

229 ignoringDiv = document.createElement("div");

230 ignoringDiv.id = "elmEventIgnorer";

231 ignoringDiv.style.position = "absolute";

232 ignoringDiv.style.top = "0px";

233 ignoringDiv.style.left = "0px";

234 ignoringDiv.style.width = "100%";

235 ignoringDiv.style.height = "100%";

237 for (var i = events.length; i-- ;) {

238 ignoringDiv.addEventListener(events[i], ignore, true);

239 }

240 runtime.node.appendChild(ignoringDiv);

241 }

242 }

244 function permitInputEvents(){

245 var ignoringDiv = document.getElementById("elmEventIgnorer");

246 ignoringDiv.parentNode.removeChild(ignoringDiv);

247 }

249 return {

250 debuggedModule: debuggedModule,

251 signalGraphNodes: signalGraphNodes,

252 initialSnapshot: snapshotSignalGraph(signalGraphNodes),

253 initialAsyncCallbacks: asyncCallbacks.slice(),

254 // API functions

255 clearAsyncCallbacks: clearAsyncCallbacks,

256 clearRecordedEvents: clearRecordedEvents,

257 getRecordedEventsLength: getRecordedEventsLength,

258 getRecordedEventAt: getRecordedEventAt,

259 copyRecordedEvents: copyRecordedEvents,

260 loadRecordedEvents: loadRecordedEvents,

261 clearSnapshots: clearSnapshots,

262 getSnapshotAt: getSnapshotAt,

263 snapshotOnCheckpoint: snapshotOnCheckpoint,

264 getPaused: getPaused,

265 setPaused: setPaused,

266 setContinue: setContinue,

267 tracePath: tracePath,

268 watchTracker: watchTracker

269 };

272function debuggerInit(debugModule, runtime, hotSwapState /* =undefined */) {

273 var currentEventIndex = 0;

275 function resetProgram(position) {

276 var closestSnapshot = debugModule.getSnapshotAt(position);

277 debugModule.clearAsyncCallbacks();

278 restoreSnapshot(debugModule.signalGraphNodes, closestSnapshot);

279 redrawGraphics();

280 }

282 function restartProgram() {

283 pauseProgram();

284 resetProgram(0);

285 debugModule.watchTracker.clear();

286 debugModule.tracePath.clearTraces();

287 debugModule.clearRecordedEvents();

288 debugModule.clearSnapshots();

289 debugModule.setContinue(0);

290 executeCallbacks(debugModule.initialAsyncCallbacks);

291 }

293 function pauseProgram() {

294 debugModule.setPaused();

295 currentEventIndex = debugModule.getRecordedEventsLength();

296 }

298 function continueProgram() {

299 if (debugModule.getPaused())

300 {

301 var closestSnapshotIndex =

302 Math.floor(currentEventIndex / EVENTS_PER_SAVE) * EVENTS_PER_SAVE;

303 resetProgram(currentEventIndex);

304 var continueIndex = currentEventIndex;

305 currentEventIndex = closestSnapshotIndex;

306 stepTo(continueIndex);

307 debugModule.setContinue(currentEventIndex);

308 }

309 }

311 function stepTo(index) {

312 if (!debugModule.getPaused()) {

313 debugModule.setPaused();

314 resetProgram();

315 }

317 if (index < 0 || index > getMaxSteps()) {

318 throw "Index out of bounds: " + index;

319 }

321 if (index < currentEventIndex) {

322 var closestSnapshotIndex = Math.floor(index / EVENTS_PER_SAVE) * EVENTS_PER_SAVE;

323 resetProgram(index);

324 currentEventIndex = closestSnapshotIndex;

325 }

327 while (currentEventIndex < index) {

328 var nextEvent = debugModule.getRecordedEventAt(currentEventIndex);

329 runtime.notify(nextEvent.id, nextEvent.value, nextEvent.timestep);

331 currentEventIndex += 1;

332 }

333 }

335 function getMaxSteps() {

336 return debugModule.getRecordedEventsLength();

337 }

339 function redrawGraphics() {

340 var main = debugModule.debuggedModule.main

341 for (var i = main.kids.length ; i-- ; ) {

342 main.kids[i].recv(runtime.timer.now(), true, main.id);

343 }

344 }

346 function getHotSwapState() {

347 var continueIndex = currentEventIndex;

348 if (!debugModule.getPaused()) {

349 continueIndex = getMaxSteps();

350 }

351 return {

352 recordedEvents: debugModule.copyRecordedEvents(),

353 currentEventIndex: continueIndex

354 };

355 }

357 function dispose() {

358 var parentNode = runtime.node.parentNode;

359 parentNode.removeChild(debugModule.tracePath.canvas);

360 parentNode.removeChild(runtime.node);

361 }

363 if (hotSwapState) {

364 // The problem is that we want to previous paused state. But

365 // by the time JS reaches here, the old code has been swapped out

366 // and the new modules are being generated. So we can ask the

367 // debugging console what it thinks the pause state is and go

368 // from there.

369 var paused = elmPauseState || false;

370 debugModule.setPaused();

371 debugModule.loadRecordedEvents(hotSwapState.recordedEvents);

372 var index = getMaxSteps();

373 runtime.debuggerStatus.eventCounter = 0;

374 debugModule.tracePath.clearTraces();

376 // draw new trace path

377 debugModule.tracePath.startRecording();

378 while(currentEventIndex < index) {

379 var nextEvent = debugModule.getRecordedEventAt(currentEventIndex);

380 runtime.debuggerStatus.eventCounter += 1;

381 runtime.notify(nextEvent.id, nextEvent.value, nextEvent.timestep);

382 debugModule.snapshotOnCheckpoint();

383 currentEventIndex += 1;

384 }

385 debugModule.tracePath.stopRecording();

387 stepTo(hotSwapState.currentEventIndex);

388 if (!paused) {

389 debugModule.setContinue(hotSwapState.currentEventIndex);

390 }

391 }

393 runtime.node.parentNode.appendChild(debugModule.tracePath.canvas);

395 var elmDebugger = {

396 restart: restartProgram,

397 pause: pauseProgram,

398 kontinue: continueProgram,

399 getMaxSteps: getMaxSteps,

400 stepTo: stepTo,

401 getPaused: debugModule.getPaused,

402 getHotSwapState: getHotSwapState,

403 dispose: dispose,

404 allNodes: debugModule.signalGraphNodes,

405 watchTracker: debugModule.watchTracker

406 };

408 return elmDebugger;

411function Point(x, y) {

412 this.x = x;

413 this.y = y;

415 this.translate = function(x, y) {

416 return new Point(this.x + x, this.y + y);

417 }

419 this.equals = function(p) {

420 return this.x == p.x && this.y == p.y;

421 }

424function tracePathInit(runtime, signalGraphMain) {

425 var List = Elm.List.make(runtime);

426 var Signal = Elm.Signal.make(runtime);

427 var tracePathNode = A2(Signal.lift, graphicsUpdate, signalGraphMain);

428 var tracePathCanvas = createCanvas();

429 var tracePositions = {};

430 var recordingTraces = true;

432 function findPositions(currentScene) {

433 var positions = {};

434 function processElement(elem, offset) {

435 if (elem.element.ctor == "Custom" && elem.element.type == "Collage")

436 {

437 List.map(F2(processForm)(offset))(elem.element.model.forms);

438 }

439 }

441 function processForm(offset, form) {

442 if (form.form.ctor == "FElement")

443 {

444 processElement(form.form._0, offset.translate(form.x, -form.y));

445 }

446 if (form.form.ctor == "FGroup")

447 {

448 var newOffset = offset.translate(form.x, -form.y);

449 List.map(F2(processForm)(newOffset))(form.form._1);

450 }

451 if (form.debugTracePathId)

452 {

453 positions[form.debugTracePathId] = new Point(form.x + offset.x, -form.y + offset.y);

454 }

455 }

457 processElement(currentScene, new Point(0, 0));

458 return positions;

459 }

461 function appendPositions(positions) {

462 for (var id in positions) {

463 var pos = positions[id];

464 if (tracePositions.hasOwnProperty(id)) {

465 tracePositions[id].push(pos);

466 }

467 else {

468 tracePositions[id] = [pos];

469 }

470 if (tracePositions[id].length < runtime.debuggerStatus.eventCounter) {

471 var padCount = runtime.debuggerStatus.eventCounter - tracePositions[id].length;

472 var lastTracePosition = tracePositions[id][tracePositions[id].length - 1];

473 for (var i = padCount; i--;) {

474 tracePositions[id].push(lastTracePosition)

475 }

476 }

477 assert(tracePositions[id].length === runtime.debuggerStatus.eventCounter,

478 "We don't have a 1-1 mapping of trace positions to events");

479 }

480 }

482 function graphicsUpdate(currentScene) {

483 if (!recordingTraces) {

484 return;

485 }

487 var ctx = tracePathCanvas.getContext('2d');

488 ctx.clearRect(0, 0, tracePathCanvas.width, tracePathCanvas.height);

490 ctx.save();

491 ctx.translate(ctx.canvas.width/2, ctx.canvas.height/2);

492 appendPositions(findPositions(currentScene));

493 for (var id in tracePositions)

494 {

495 ctx.beginPath();

496 var points = tracePositions[id];

497 for (var i=0; i < points.length; i++)

498 {

499 var p = points[i];

500 if (i == 0) {

501 ctx.moveTo(p.x, p.y);

502 }

503 else {

504 ctx.lineTo(p.x, p.y);

505 }

506 }

507 ctx.lineWidth = 1;

508 ctx.strokeStyle = "rgba(50, 50, 50, 0.4)";

509 ctx.stroke();

510 }

512 ctx.restore();

513 }

515 function clearTraces() {

516 tracePositions = {};

517 }

519 function stopRecording() {

520 recordingTraces = false;

521 }

523 function startRecording() {

524 recordingTraces = true;

525 }

527 function clearTracesAfter(position) {

528 var newTraces = {};

529 for (var id in tracePositions) {

530 newTraces[id] = tracePositions[id].slice(0,position);

531 }

532 tracePositions = newTraces;

533 }

535 return {

536 graphicsUpdate: graphicsUpdate,

537 canvas: tracePathCanvas,

538 clearTraces: clearTraces,

539 clearTracesAfter: clearTracesAfter,

540 stopRecording: stopRecording,

541 startRecording: startRecording

542 }

545function executeCallbacks(callbacks) {

546 callbacks.forEach(function(timer) {

547 if (!timer.executed) {

548 var func = timer.func;

549 timer.executed = true;

550 func();

551 }

552 });

555function createCanvas() {

556 var c = document.createElement('canvas');

557 c.width = window.innerWidth;

558 c.height = window.innerHeight;

559 c.style.position = "absolute";

560 c.style.top = "0";

561 c.style.left = "0";

562 c.style.pointerEvents = "none";

563 return c;

566function assert(bool, msg) {

567 if (!bool) {

568 throw "Assertion error: " + msg;

569 }

572function snapshotSignalGraph(signalGraphNodes) {

573 var nodeValues = [];

575 signalGraphNodes.forEach(function(node) {

576 nodeValues.push({ value: node.value, id: node.id });

577 });

579 return nodeValues;

582function restoreSnapshot(signalGraphNodes, snapshot) {

583 assert(signalGraphNodes.length == snapshot.length,

584 "saved program state has wrong length");

585 for (var i=0; i < signalGraphNodes.length; i++) {

586 var node = signalGraphNodes[i];

587 var state = snapshot[i];

588 assert(node.id == state.id, "the nodes moved position");

590 node.value = state.value;

591 }

594function flattenSignalGraph(nodes) {

595 var nodesById = {};

597 function addAllToDict(node) {

598 nodesById[node.id] = node;

599 node.kids.forEach(addAllToDict);

600 }

601 nodes.forEach(addAllToDict);

603 var allNodes = Object.keys(nodesById).sort().map(function(key) {

604 return nodesById[key];

605 });

606 return allNodes;

609}());