Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
1. Run `npx serve` and go to `http://localhost:3000`
2. There is no step 2

### Runtime lifecycle tests

Run `node --test tests/restore-file.test.cjs` from this directory. The tests use
the bundled v86 lifecycle methods with a controlled CPU; they do not boot a
guest image.

## :hammer_and_wrench: Update the filesystem

1. Run the build process in the [buildroot](/packages/buildroot/README.md#getting-started) package
Expand Down
2 changes: 1 addition & 1 deletion packages/runtime/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,9 @@
document.getElementById("restore_file").onchange = function () {
if (this.files.length) {
var filereader = new FileReader();
emulator.stop();

filereader.onload = async function (e) {
await emulator.stop();
await emulator.restore_state(e.target.result);
emulator.run();
};
Expand Down
80 changes: 80 additions & 0 deletions packages/runtime/tests/restore-file.test.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const test = require('node:test');
const vm = require('node:vm');
const { V86 } = require('../lib/libv86.js');

const html = fs.readFileSync(path.join(__dirname, '../index.html'), 'utf8');
const startup = [...html.matchAll(/<script>([\s\S]*?)<\/script>/g)]
.map(match => match[1]).find(script => script.includes('window.onload'));

function setup(running = true) {
const elements = new Map();
const events = [];
const listeners = new Map();
let reader;
// Exercise the bundled V86 stop/restore/run methods with a controlled CPU.
// No guest image is booted by these lifecycle tests.
const emulator = Object.create(V86.prototype);
emulator.cpu_is_running = running;
emulator.add_listener = (name, callback) => listeners.set(name, callback);
emulator.remove_listener = name => listeners.delete(name);
emulator.v86 = {
stop() { events.push('stop requested'); },
restore_state(bytes) { events.push(['restore', bytes]); },
run() { events.push('run'); },
};
const context = {
window: {}, URL, TextEncoder, console,
document: {
location: 'http://localhost/',
getElementById(id) {
if (!elements.has(id)) elements.set(id, { blur() {} });
return elements.get(id);
},
getElementsByClassName() { return []; },
},
V86: function () { return emulator; },
FileReader: class {
constructor() { reader = this; }
readAsArrayBuffer() {}
},
};
vm.runInNewContext(startup, context);
context.window.onload();
const input = elements.get('restore_file');
input.files = [{}];
input.onchange();
return {
reader, events,
stopped() {
emulator.cpu_is_running = false;
listeners.get('emulator-stopped')();
},
};
}

test('waits for the emulator-stopped event before restoring and running', async () => {
const fixture = setup();
const bytes = new ArrayBuffer(4);
const restored = fixture.reader.onload({ target: { result: bytes } });
await Promise.resolve();
assert.deepEqual(fixture.events, ['stop requested']);
fixture.stopped();
await restored;
assert.deepEqual(fixture.events, ['stop requested', ['restore', bytes], 'run']);
});

test('does not stop the current session while the selected file is unreadable', () => {
const fixture = setup();
// A failed/aborted FileReader does not dispatch load.
assert.deepEqual(fixture.events, []);
});

test('restores an already stopped emulator without waiting for another stop event', async () => {
const fixture = setup(false);
const bytes = new ArrayBuffer(4);
await fixture.reader.onload({ target: { result: bytes } });
assert.deepEqual(fixture.events, [['restore', bytes], 'run']);
});