feat(sim): F4.6f1 what a run leaves goes back into the document
The oracle SaveAfterRunRun saves Java's project after a run. The room writes what a run leaves that Java keeps - files, running servers, virtual hosts, mail servers' domains and accounts, mail programs' accounts and folders, firewalls, DHCP clients' addresses - into the document as origin 'sim', at most once a second, after each action and at the stop; writeRunState writes only what differs. The command line now goes on in a folder made before a restart, as Java's does. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Claude Opus 5.5
BIN
Binary file not shown.
BIN
Binary file not shown.
@@ -1,9 +1,8 @@
|
||||
// The room's command line window against Java's (tools/java-oracle
|
||||
// TerminalWindowRun): the same keys typed into a computer's window, the same
|
||||
// text, prompt and history after each, over a stop and a start. One
|
||||
// difference is named: what a run made in the files is not yet written back
|
||||
// into the document (F4.6f), so after the restart the folder made before is
|
||||
// gone and the window goes on at the root, where Java's goes on in it.
|
||||
// text, prompt and history after each, over a stop and a start — the
|
||||
// folder made before the stop is in the project afterwards (written back,
|
||||
// F4.6f), and the window goes on in it, as Java's does.
|
||||
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { dirname, join } from 'node:path';
|
||||
@@ -59,9 +58,6 @@ function setUp(programs: readonly string[] = ['commandPrompt']) {
|
||||
return { doc, room, send, run, read, got, connect: (listener: (message: HostMessage) => void) => room.connect(listener) };
|
||||
}
|
||||
|
||||
/** Until the files of a run are written back (F4.6f): the folder made before the restart is gone, the window goes on at the root. */
|
||||
const FILES_NOT_KEPT_YET = (text: string) => text.replaceAll('/dir', '/');
|
||||
|
||||
describe("a command line's window", () => {
|
||||
it("shows what Java's window shows, key by key, over a stop and a start", () => {
|
||||
const { send, run, read } = setUp();
|
||||
@@ -70,7 +66,6 @@ describe("a command line's window", () => {
|
||||
run(TICK_MILLISECONDS);
|
||||
let pointer = -1;
|
||||
let input = '';
|
||||
let restartedAt: number | undefined;
|
||||
for (const step of java.steps) {
|
||||
if (step.step.startsWith('enter:')) {
|
||||
send({ kind: 'input', node: 'pc', app: 'terminal', action: 'enter', args: { line: step.step.slice('enter:'.length) }, reqId: step.step });
|
||||
@@ -85,13 +80,9 @@ describe("a command line's window", () => {
|
||||
send({ kind: 'stop' });
|
||||
send({ kind: 'start' });
|
||||
run(400);
|
||||
restartedAt = terminalScreen(read()).text.length;
|
||||
}
|
||||
const screen = terminalScreen(read());
|
||||
const expected =
|
||||
restartedAt === undefined
|
||||
? step
|
||||
: { ...step, text: step.text.slice(0, restartedAt) + FILES_NOT_KEPT_YET(step.text.slice(restartedAt)), prompt: FILES_NOT_KEPT_YET(step.prompt) };
|
||||
const expected = step;
|
||||
expect({ text: screen.text, prompt: screen.prompt, promptShown: screen.promptShown, input }, step.step).toEqual({
|
||||
text: expected.text,
|
||||
prompt: expected.prompt,
|
||||
@@ -120,9 +111,9 @@ describe("a command line's window", () => {
|
||||
send({ kind: 'start' });
|
||||
run(400);
|
||||
expect(terminalScreen(read()).prompt).toBe('/docs> ');
|
||||
// The folder gone from the project: the next start goes on at the root.
|
||||
files.delete('/docs');
|
||||
// The folder gone from the project (in the design): the next start goes on at the root.
|
||||
send({ kind: 'stop' });
|
||||
files.delete('/docs');
|
||||
send({ kind: 'start' });
|
||||
run(400);
|
||||
expect(terminalScreen(read()).prompt).toBe('/> ');
|
||||
|
||||
@@ -0,0 +1,242 @@
|
||||
// What a run leaves in the document, against what Java's project holds when
|
||||
// it is saved after the same run (tools/java-oracle SaveAfterRunRun,
|
||||
// fixtures/after-run-*.fls; both read with the same reader): the files a
|
||||
// command line made, the accounts and mails, which servers run, the virtual
|
||||
// hosts, a new domain; the addresses DHCP clients got. Named: the virtual
|
||||
// hosts' file holds the complete rows only (F4.6d).
|
||||
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import * as Y from 'yjs';
|
||||
import { VirtualFileSystem as VirtualFileSystemOf, type Id, type VirtualFileSystem } from '@mdg-filius/core';
|
||||
import { createUndoManager, readProject, ROOTS, setSoftware, SIM_ORIGIN, writeProject, writeRunState } from '@mdg-filius/doc';
|
||||
import { openProjectArchive, type ImportedProject } from '@mdg-filius/fls';
|
||||
import type { HostMessage } from '@mdg-filius/protocol';
|
||||
import { SimulationRoom, TICK_MILLISECONDS, WRITE_BACK_MILLISECONDS } from '../src/index.js';
|
||||
|
||||
const here = dirname(fileURLToPath(import.meta.url));
|
||||
const corpus = join(here, '../../../corpus/java-examples');
|
||||
|
||||
function open(path: string): ImportedProject {
|
||||
let ids = 0;
|
||||
return openProjectArchive(new Uint8Array(readFileSync(path)), () => `00000000-0000-0000-0000-${(++ids).toString(16).padStart(12, '0')}`);
|
||||
}
|
||||
|
||||
function setUp(file: string, writeBackMilliseconds?: number) {
|
||||
const doc = new Y.Doc();
|
||||
writeProject(doc, open(join(corpus, file)));
|
||||
let now = 1_000_000;
|
||||
const room = new SimulationRoom(doc, { now: () => now, seed: () => 5, ...(writeBackMilliseconds === undefined ? {} : { writeBackMilliseconds }) });
|
||||
const got: HostMessage[] = [];
|
||||
const client = room.connect((message) => got.push(message));
|
||||
const id = (name: string) => readProject(doc).graph.nodes.find((node) => node.displayName === name)!.id;
|
||||
const act = (node: string, app: string, action: string, args: object = {}) => room.receive(client, { v: 1, kind: 'input', node: id(node), app, action, args, reqId: `${app}.${action}` });
|
||||
const run = (milliseconds: number) => {
|
||||
for (let elapsed = 0; elapsed < milliseconds; elapsed += TICK_MILLISECONDS) {
|
||||
now += TICK_MILLISECONDS;
|
||||
room.tick();
|
||||
}
|
||||
};
|
||||
return { doc, room, got, id, act, run, send: (message: object) => room.receive(client, { v: 1, ...message }) };
|
||||
}
|
||||
|
||||
/** A computer's files: text as it is, the rest by kind. */
|
||||
function filesOf(files: VirtualFileSystem | undefined): Record<string, string> {
|
||||
return Object.fromEntries((files?.allEntries() ?? []).map((entry) => [entry.path, entry.content.kind === 'text' ? entry.content.text : entry.content.kind]));
|
||||
}
|
||||
|
||||
/** What a run leaves of a node, as the model holds it. */
|
||||
function slice(project: ImportedProject, name: string) {
|
||||
const id = project.graph.nodes.find((node) => node.displayName === name)!.id;
|
||||
return {
|
||||
files: filesOf(project.virtualFileSystems.get(id)),
|
||||
programs: [...(project.installedPrograms.get(id) ?? [])].sort(),
|
||||
active: [...(project.activePrograms.get(id) ?? [])].sort(),
|
||||
webServer: project.webServerConfigurations.get(id),
|
||||
emailServer: project.emailServerConfigurations.get(id),
|
||||
emailClient: project.emailClientConfigurations.get(id),
|
||||
firewall: project.firewallConfigurationsByNodeId.get(id),
|
||||
};
|
||||
}
|
||||
|
||||
const ACCOUNT = (user: string, last: string) => ({ name: `Rechner ${last}`, email: `${user}@filius.de`, pop3Host: '141.99.50.232', pop3Port: '110', smtpHost: '141.99.50.232', smtpPort: '25', username: user, password: user });
|
||||
|
||||
describe("what a run leaves in the document, against Java's project saved after it", () => {
|
||||
it('keeps the files, accounts, mails, servers, virtual hosts and domain of a run', () => {
|
||||
const { doc, id, act, run, send } = setUp('email_komplett.fls');
|
||||
setSoftware(doc, id('Rechner 1'), { install: ['commandPrompt'], remove: [] }, 'de', 'me');
|
||||
send({ kind: 'start' });
|
||||
run(2_000);
|
||||
act('Rechner 1', 'terminal', 'enter', { line: 'mkdir ordner' });
|
||||
run(500);
|
||||
act('Rechner 1', 'terminal', 'enter', { line: 'touch ordner/notiz.txt' });
|
||||
run(500);
|
||||
act('Rechner 1', 'emailClient', 'setAccount', ACCOUNT('rechner1', '1'));
|
||||
act('Rechner 2', 'emailClient', 'setAccount', ACCOUNT('rechner2', '2'));
|
||||
act('Rechner 1', 'emailClient', 'send', { to: 'rechner2@filius.de', cc: '', bcc: '', subject: 'Nach dem Lauf', text: 'Erste Zeile\nZweite Zeile' });
|
||||
run(8_000);
|
||||
act('Rechner 2', 'emailClient', 'fetch');
|
||||
run(8_000);
|
||||
act('Mail-Server (filius.de)', 'emailServer', 'addAccount', { username: 'neu', password: 'pw', firstName: 'Vorname', lastName: 'Nachname' });
|
||||
act('Web-Server', 'webServer', 'setActive', { active: false });
|
||||
act('Web-Server', 'webServer', 'useVirtualHosts', { use: true });
|
||||
act('Web-Server', 'webServer', 'setVirtualHost', { row: 0, column: 0, value: 'a.de' });
|
||||
act('Web-Server', 'webServer', 'setVirtualHost', { row: 0, column: 1, value: 'ordner' });
|
||||
act('Mail-Server (senior.de)', 'emailServer', 'setActive', { active: false });
|
||||
act('Mail-Server (senior.de)', 'emailServer', 'setDomain', { domain: 'senior.org' });
|
||||
run(1_000);
|
||||
send({ kind: 'stop' });
|
||||
|
||||
const ours = readProject(doc);
|
||||
const java = open(join(here, 'fixtures/after-run-email.fls'));
|
||||
for (const name of ['Rechner 1', 'Rechner 2', 'Rechner 3', 'Mail-Server (filius.de)', 'Mail-Server (senior.de)', 'DNS-Server']) {
|
||||
expect(slice(ours, name), name).toEqual(slice(java, name));
|
||||
}
|
||||
// The virtual hosts' file holds the complete rows (Java's every row, the empty ones as empty lines).
|
||||
const web = slice(java, 'Web-Server');
|
||||
expect(web.files['/www.conf/vhosts']).toBe('a.de\nordner\n\n\n\n\n\n\n\n\n');
|
||||
expect(slice(ours, 'Web-Server')).toEqual({ ...web, files: { ...web.files, '/www.conf/vhosts': 'a.de\nordner\n' } });
|
||||
});
|
||||
|
||||
it('keeps the addresses DHCP clients got', () => {
|
||||
const { doc, run, send } = setUp('einfaches_rechnernetz_komplett.fls');
|
||||
send({ kind: 'start' });
|
||||
run(20_000);
|
||||
// Written while it runs, not only at the stop.
|
||||
const running = readProject(doc);
|
||||
send({ kind: 'stop' });
|
||||
expect(readProject(doc).deviceConfigurations).toEqual(running.deviceConfigurations);
|
||||
const devices = (project: ImportedProject) =>
|
||||
project.graph.nodes
|
||||
.filter((node) => project.dhcpClientConfigurations.get(node.id)?.isEnabled === true)
|
||||
.map((node) => project.deviceConfigurations.get(node.id)!)
|
||||
// Which client gets which address is the threads' race in Java.
|
||||
.map(({ ipAddress, ...rest }) => ({ ...rest, ipAddress: ipAddress.startsWith('192.168.0.') ? 'leased' : ipAddress }));
|
||||
const java = open(join(here, 'fixtures/after-run-dhcp.fls'));
|
||||
const before = open(join(corpus, 'einfaches_rechnernetz_komplett.fls'));
|
||||
expect(devices(readProject(doc))).toEqual(devices(java));
|
||||
expect(devices(before)).not.toEqual(devices(java));
|
||||
const addresses = (project: ImportedProject) =>
|
||||
project.graph.nodes.filter((node) => project.dhcpClientConfigurations.get(node.id)?.isEnabled === true).map((node) => project.deviceConfigurations.get(node.id)!.ipAddress).sort();
|
||||
expect(addresses(readProject(doc))).toEqual(addresses(java));
|
||||
});
|
||||
});
|
||||
|
||||
describe("the room's write-back", () => {
|
||||
it('writes while the simulation runs, at most once a second, after an action and at the stop, as the room', () => {
|
||||
const { doc, id, act, run, send } = setUp('email_komplett.fls');
|
||||
const origins: unknown[] = [];
|
||||
doc.on('update', (_update: Uint8Array, origin: unknown) => origins.push(origin));
|
||||
const node = id('Mail-Server (filius.de)');
|
||||
const accounts = () => (readProject(doc).emailServerConfigurations.get(node)?.accounts ?? []).map((account) => account.username);
|
||||
send({ kind: 'start' });
|
||||
run(TICK_MILLISECONDS);
|
||||
act('Mail-Server (filius.de)', 'emailServer', 'addAccount', { username: 'neu', password: 'pw', firstName: 'A', lastName: 'B' });
|
||||
expect(accounts()).toContain('neu');
|
||||
expect(origins.length).toBeGreaterThan(0);
|
||||
expect(new Set(origins)).toEqual(new Set([SIM_ORIGIN]));
|
||||
// Nothing new: nothing is written.
|
||||
const written = origins.length;
|
||||
run(3 * WRITE_BACK_MILLISECONDS);
|
||||
expect(origins.length).toBe(written);
|
||||
send({ kind: 'stop' });
|
||||
expect(origins.length).toBe(written);
|
||||
});
|
||||
|
||||
it('writes at the stop what it left since the last write', () => {
|
||||
const { doc, id, run, send } = setUp('einfaches_rechnernetz_komplett.fls', 60_000);
|
||||
const notebook = id('Notebook 1');
|
||||
const before = readProject(doc).deviceConfigurations.get(notebook);
|
||||
send({ kind: 'start' });
|
||||
run(20_000);
|
||||
expect(readProject(doc).deviceConfigurations.get(notebook)).toEqual(before);
|
||||
send({ kind: 'stop' });
|
||||
expect(readProject(doc).deviceConfigurations.get(notebook)!.ipAddress).toMatch(/^192\.168\.0\./);
|
||||
});
|
||||
|
||||
it('removes from the document what a command line removed', () => {
|
||||
const { doc, id, act, run, send } = setUp('email_komplett.fls');
|
||||
const node = id('Rechner 1');
|
||||
setSoftware(doc, node, { install: ['commandPrompt'], remove: [] }, 'de', 'me');
|
||||
const files = () => Object.keys(Object.fromEntries((readProject(doc).virtualFileSystems.get(node)?.allEntries() ?? []).map((entry) => [entry.path, true])));
|
||||
expect(files()).toContain('/konten.txt');
|
||||
send({ kind: 'start' });
|
||||
run(TICK_MILLISECONDS);
|
||||
act('Rechner 1', 'terminal', 'enter', { line: 'rm konten.txt' });
|
||||
expect(files()).not.toContain('/konten.txt');
|
||||
});
|
||||
|
||||
it("is never a person's step to take back", () => {
|
||||
const { doc, id, act, run, send } = setUp('email_komplett.fls');
|
||||
const undo = createUndoManager(doc, 'me');
|
||||
send({ kind: 'start' });
|
||||
run(TICK_MILLISECONDS);
|
||||
act('Web-Server', 'webServer', 'setActive', { active: false });
|
||||
send({ kind: 'stop' });
|
||||
expect(readProject(doc).activePrograms.get(id('Web-Server'))).toBeUndefined();
|
||||
expect(undo.undoStack).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('writes a text where it changed, keeps a file another wrote meanwhile, and removes a file the run removed', () => {
|
||||
const doc = new Y.Doc();
|
||||
const { doc: source } = setUp('email_komplett.fls');
|
||||
writeProject(doc, readProject(source));
|
||||
const nodeId = readProject(doc).graph.nodes.find((node) => node.displayName === 'Rechner 1')!.id as Id;
|
||||
const files = () => doc.getMap<Y.Map<unknown>>(ROOTS.nodes).get(nodeId)!.get('files') as Y.Map<Y.Map<unknown>>;
|
||||
const fileSystem = readProject(doc).virtualFileSystems.get(nodeId)!;
|
||||
fileSystem.createDirectory('/neu');
|
||||
fileSystem.writeTextFile('/neu/a.txt', 'Anfang Mitte Ende');
|
||||
writeRunState(doc, new Map([[nodeId, { files: fileSystem }]]));
|
||||
const text = files().get('/neu/a.txt')!.get('text') as Y.Text;
|
||||
expect(text.toString()).toBe('Anfang Mitte Ende');
|
||||
const order = files().get('/neu/a.txt')!.get('order');
|
||||
// The run changes the middle; the entry and its text stay the same objects.
|
||||
fileSystem.writeTextFile('/neu/a.txt', 'Anfang neue Mitte Ende');
|
||||
const changes: string[] = [];
|
||||
text.observe((event) => changes.push(JSON.stringify(event.delta)));
|
||||
writeRunState(doc, new Map([[nodeId, { files: fileSystem }]]));
|
||||
expect([files().get('/neu/a.txt')!.get('text'), text.toString(), files().get('/neu/a.txt')!.get('order')]).toEqual([text, 'Anfang neue Mitte Ende', order]);
|
||||
expect(changes).toEqual([JSON.stringify([{ retain: 7 }, { insert: 'neue ' }])]);
|
||||
// A file turned into a folder, and one removed.
|
||||
fileSystem.deleteItem('/neu/a.txt');
|
||||
fileSystem.createDirectory('/neu/a.txt');
|
||||
fileSystem.deleteItem('/konten.txt');
|
||||
writeRunState(doc, new Map([[nodeId, { files: fileSystem }]]));
|
||||
expect(files().get('/neu/a.txt')!.get('kind')).toBe('directory');
|
||||
expect(files().get('/neu/a.txt')!.get('order')).toBe(order);
|
||||
expect(files().has('/konten.txt')).toBe(false);
|
||||
// An image's bytes and type.
|
||||
fileSystem.writeImageFile('/bild.png', new Uint8Array([1, 2]), 'image/png');
|
||||
writeRunState(doc, new Map([[nodeId, { files: fileSystem }]]));
|
||||
fileSystem.writeImageFile('/bild.png', new Uint8Array([1, 3]), 'image/png');
|
||||
writeRunState(doc, new Map([[nodeId, { files: fileSystem }]]));
|
||||
expect(files().get('/bild.png')!.get('data')).toEqual(new Uint8Array([1, 3]));
|
||||
fileSystem.writeImageFile('/bild.png', new Uint8Array([1, 3]), 'image/gif');
|
||||
writeRunState(doc, new Map([[nodeId, { files: fileSystem }]]));
|
||||
expect(files().get('/bild.png')!.get('mediaType')).toBe('image/gif');
|
||||
// A setting written again alike, its fields in another order or one undefined: nothing; with a field less: written.
|
||||
const settingsDoc = new Y.Doc();
|
||||
writeProject(settingsDoc, readProject(source));
|
||||
const server = readProject(settingsDoc).graph.nodes.find((node) => node.displayName === 'Web-Server')!.id;
|
||||
const web = readProject(settingsDoc).webServerConfigurations.get(server)!;
|
||||
const updates: unknown[] = [];
|
||||
settingsDoc.on('update', (update: Uint8Array) => updates.push(update));
|
||||
writeRunState(settingsDoc, new Map([[server, { settings: { webServer: { virtualHosts: web.virtualHosts, documentRoot: web.documentRoot, port: web.port, extra: undefined } } }]]));
|
||||
expect(updates).toHaveLength(0);
|
||||
writeRunState(settingsDoc, new Map([[server, { settings: { webServer: { port: web.port, documentRoot: web.documentRoot } } }]]));
|
||||
expect(updates).toHaveLength(1);
|
||||
expect(readProject(settingsDoc).webServerConfigurations.get(server)).toEqual({ port: web.port, documentRoot: web.documentRoot });
|
||||
writeRunState(settingsDoc, new Map([[server, { settings: { webServer: { port: web.port, documentRoot: web.documentRoot, virtualHosts: true } } }]]));
|
||||
expect(updates).toHaveLength(2);
|
||||
// A node without files whose run has none: no files.
|
||||
const switchId = readProject(settingsDoc).graph.nodes.find((node) => node.kind === 'networkSwitch')!.id;
|
||||
writeRunState(settingsDoc, new Map([[switchId, { files: new VirtualFileSystemOf() }]]));
|
||||
expect(settingsDoc.getMap<Y.Map<unknown>>(ROOTS.nodes).get(switchId)!.has('files')).toBe(false);
|
||||
// A node the document no longer has, and settings it has not: nothing.
|
||||
writeRunState(doc, new Map([['niemand', { files: fileSystem }]]));
|
||||
writeRunState(doc, new Map([[nodeId, { settings: { webServer: { port: 80 } } }]]));
|
||||
expect(readProject(doc).webServerConfigurations.has(nodeId)).toBe(false);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user