Luigit
repositories / dotfiles

dotfiles

bugabingas dorkfiles

owned by admin

quickshell/nuguland/diagnostics.test.mjs

Raw
import assert from 'node:assert/strict';
import { readFileSync } from 'node:fs';
import vm from 'node:vm';
import { createRequire } from 'node:module';

const { registryEntries } = createRequire(import.meta.url)('./test-fixtures/sources.js');

const read = name => readFileSync(new URL(name, import.meta.url), 'utf8');
const data = vm.createContext({});
vm.runInContext(read('diagnostics.js').replace(/^\.(?:pragma|import).*$/gm, ''), data);
const plain = value => JSON.parse(JSON.stringify(value));
const sentinel = 'SENSITIVE-title-clipboard-vault-account-SSID-prompt-url';
// Registry popups from Registry.qml itself; names outside it are unknown.
const popups = registryEntries().filter(entry => entry.kind === 'popup').map(entry => ({
    width: 520, height: 300, empty: false, ...entry, retainedState: { scrollY: 0 }, opening() {}, dismissed() {},
}));
const registry = { popups, popup: name => popups.find(entry => entry.name === String(name)) || null };
const sensitive = {
    title: sentinel, text: sentinel, records: [sentinel], account: sentinel,
    ssid: sentinel, prompt: sentinel, url: sentinel, error: sentinel,
    stateJson() { throw new Error('diagnostics must not dump service JSON'); },
};
const surfaces = {
    ...sensitive, registry, operationId: 17, popupOpen: true,
    popupPhase: 'opening', popupName: 'clock', popupOutput: sentinel,
    lastCloseReason: sentinel, popupProgress: 0,
    screenWidth: 1366, screenHeight: 768, barHeight: 34, orientation: 'horizontal',
    popupAnchor: { ...sensitive, x: 10, y: 0, width: 40, height: 34 },
    popupCardFrame() { return { ...sensitive, currentRect: { x: 269, y: 16, width: 828, height: 564 } }; },
};
const screens = [{ ...sensitive, name: sentinel, x: -1366, y: 0, width: 1366, height: 768, devicePixelRatio: 1.25 }];
const services = {
    niri: { ...sensitive, available: true, ready: true, windows: [sensitive], workspaces: [sensitive, sensitive] },
    audio: { ...sensitive, pipewireReady: true },
    network: { ...sensitive, wifiEnabled: true, scanning: false },
    vault: { ...sensitive, status: 'locked', lockPending: false },
    noko: { ...sensitive, ready: true, overlayState: 'starting', installing: false, wakeListening: true, liveText: sentinel },
};
const snapshot = plain(data.snapshot(surfaces, screens, services));
assert.deepEqual(snapshot, {
    version: 1,
    popup: {
        operationId: 17, name: 'clock', phase: 'opening', open: true, closing: false,
        orientation: 'horizontal', progress: 0,
        anchor: { x: 10, y: 0, width: 40, height: 34 },
        card: { x: 269, y: 16, width: 828, height: 564 },
        viewport: { width: 1366, height: 768, barHeight: 34 },
    },
    displays: [{ x: -1366, y: 0, width: 1366, height: 768, scale: 1.25 }],
    services: {
        niri: { available: true, ready: true, windowCount: 1, workspaceCount: 2 },
        audio: { ready: true }, network: { enabled: true, scanning: false },
        vault: { status: 'locked', lockPending: false },
        noko: { ready: true, phase: 'starting', installing: false, wakeListening: true },
    },
});
assert(!JSON.stringify(snapshot).includes(sentinel));
for (const name of popups.map(entry => entry.name)) {
    surfaces.popupName = name;
    assert.equal(data.popup(surfaces).name, name);
}
for (const name of [sentinel, '__proto__', 'constructor', 'toString']) {
    surfaces.popupName = name;
    surfaces.popupPhase = sentinel;
    surfaces.orientation = sentinel;
    services.vault.status = sentinel;
    services.noko.overlayState = sentinel;
    const safe = plain(data.snapshot(surfaces, screens, services));
    assert.equal(safe.popup.name, 'unknown');
    assert.equal(safe.popup.phase, 'unknown');
    assert.equal(safe.popup.orientation, 'unknown');
    assert.equal(safe.services.vault.status, 'unknown');
    assert.equal(safe.services.noko.phase, 'unknown');
    assert(!JSON.stringify(safe).includes(sentinel));
}
// Strings in numeric/boolean fields must not become another path for free text.
const malformed = plain(data.snapshot({
    ...surfaces, operationId: sentinel, popupOpen: sentinel, popupProgress: Infinity,
    screenWidth: sentinel, popupAnchor: { x: sentinel, y: NaN, width: Infinity, height: -Infinity },
}, [{ x: sentinel, y: NaN, width: Infinity, height: -Infinity, devicePixelRatio: sentinel }], services));
assert.deepEqual(malformed.popup.anchor, { x: 0, y: 0, width: 0, height: 0 });
assert.deepEqual(malformed.displays, [{ x: 0, y: 0, width: 0, height: 0, scale: 0 }]);
assert.equal(malformed.popup.operationId, 0);
assert.equal(malformed.popup.open, false);
assert.equal(malformed.popup.closing, false);
assert.equal(data.phase('closing'), 'closing', 'version 1 phase vocabulary stays compatible');
assert.equal(malformed.popup.progress, 0);
assert(!JSON.stringify(malformed).includes(sentinel));
assert.equal(data.nextOperationId(0), 1);
assert.equal(data.nextOperationId(2147483647), 1);
assert.equal(data.nextOperationId(41), 42);

// Exercise the actual shared lifecycle functions and timer completion, not a model of them.
const qml = read('SurfaceManager.qml');
const logs = [];
const context = vm.createContext({
    ...surfaces, operationId: 0, popupOpen: false,
    popupPhase: 'closed', popupName: '', orientation: 'horizontal',
    panelHeight: 0, panelSettled: false, vertical: false, goldenRatio: 1.61803,
    dismissing() {}, niriService: null, returnWindowId: null,
    DiagnosticData: data,
    console: { info: line => logs.push(JSON.parse(line)) },
    Qt: { rect: (x, y, width, height) => ({ x, y, width, height }) },
    openTimer: { stop() {}, restart() {} },
});
context.root = context;
const start = qml.indexOf('    function dismissTask(');
vm.runInContext(qml.slice(start, qml.indexOf('    Timer {', start)).replaceAll('anchor: rect', 'anchor'), context);
const anchor = { x: 10, y: 0, width: 40, height: 34 };
context.openPopup('clock', anchor, sentinel);
context.completeOpen();
context.openPopup('system', anchor, sentinel);
context.closePopup(sentinel);
context.completeOpen(); // A stopped/deferred completion cannot emit another record.
context.closePopup(sentinel); // No-op closes allocate no operation.
assert.deepEqual(logs.map(({ operationId, event }) => [operationId, event]), [
    [1, 'opening'], [1, 'opened'], [2, 'switched'], [3, 'closed'],
]);
assert.equal(data.popup(context).operationId, 3);
// A name outside the registry never opens, so it never logs or allocates an operation.
context.openPopup(sentinel, anchor, sentinel);
context.closePopup(sentinel);
context.completeOpen();
assert.equal(logs.length, 4);
assert.equal(context.popupOpen, false);
context.openPopup('clock', anchor, sentinel);
context.openPopup('system', anchor, sentinel);
context.completeOpen(); // Switching already completed the opening and stopped its timer.
assert.deepEqual(logs.slice(4).map(({ operationId, event }) => [operationId, event]), [
    [4, 'opening'], [5, 'switched'],
]);
for (const log of logs) {
    assert.deepEqual(Object.keys(log), ['version', 'kind', 'operationId', 'event', 'name', 'phase']);
    assert.equal(log.version, 1);
    assert.equal(log.kind, 'popup-transition');
    assert(!JSON.stringify(log).includes(sentinel));
}
assert.equal(data.transition(sentinel, surfaces).event, 'unknown');
assert.match(qml, /onTriggered: root\.completeOpen\(\)/);
const composition = read('Diagnostics.qml');
assert.doesNotMatch(composition, /stateJson\(|Quickshell\.exec|Process\s*\{/);
for (const type of ['SurfaceManager', 'Niri', 'Audio', 'Network', 'Vault', 'Noko'])
    assert.match(composition, new RegExp(`required property ${type} `));
assert.match(read('shell.qml'), /function diagnostics\(\): string\s*\{\s*return diagnosticsService\.snapshot\(\);/);
console.log('diagnostics.test.mjs: ALL PASS');