feat: frontend tests — import/export validator + unit tests + CI integration
All checks were successful
CI / lint (push) Successful in 14s
CI / security (push) Successful in 11s
CI / test (push) Successful in 17s
CI / build (push) Successful in 2s

- tests/frontend/validate-imports.mjs: 0 errors on 13 modules, 79 exports
  Detects: missing exports, broken imports, const reassignments
- tests/frontend/unit.test.mjs: escapeHtml, state object, module syntax
- Added to CI lint job (runs after Ruff + Mypy)
This commit is contained in:
Bruno Charest 2026-05-28 18:46:10 -04:00
parent 2c6c74419c
commit ffc6dac172
4 changed files with 350 additions and 4 deletions

View File

@ -32,6 +32,12 @@ jobs:
- name: Mypy (type checker) - name: Mypy (type checker)
run: mypy backend/ --ignore-missing-imports || echo "mypy found type errors (advisory — 28 pre-existing issues)" run: mypy backend/ --ignore-missing-imports || echo "mypy found type errors (advisory — 28 pre-existing issues)"
- name: Frontend validation
run: node tests/frontend/validate-imports.mjs
- name: Frontend unit tests
run: node tests/frontend/unit.test.mjs
# ── Tests ───────────────────────────────────────────────────────── # ── Tests ─────────────────────────────────────────────────────────
test: test:
needs: lint needs: lint

View File

@ -44,7 +44,7 @@ function hideProgressBar() {
// loadVaultSettings // loadVaultSettings
// ========================================================================= // =========================================================================
async function loadVaultSettings() { export async function loadVaultSettings() {
try { try {
const settings = await api("/api/vaults/settings/all"); const settings = await api("/api/vaults/settings/all");
state.vaultSettings = settings; state.vaultSettings = settings;
@ -84,7 +84,7 @@ function _isInputFocused() {
// initSearch // initSearch
// ========================================================================= // =========================================================================
function initSearch() { export function initSearch() {
const input = document.getElementById("search-input"); const input = document.getElementById("search-input");
if (!input) return; if (!input) return;
const caseBtn = document.getElementById("search-case-btn"); const caseBtn = document.getElementById("search-case-btn");
@ -309,7 +309,7 @@ function initSearch() {
// showWelcome // showWelcome
// ========================================================================= // =========================================================================
function showWelcome() { export function showWelcome() {
hideProgressBar(); hideProgressBar();
// Restore or rebuild the dashboard with tabbed sections // Restore or rebuild the dashboard with tabbed sections
@ -422,7 +422,7 @@ function showWelcome() {
// goHome // goHome
// ========================================================================= // =========================================================================
function goHome() { export function goHome() {
const searchInput = document.getElementById("search-input"); const searchInput = document.getElementById("search-input");
if (searchInput) searchInput.value = ""; if (searchInput) searchInput.value = "";

View File

@ -0,0 +1,149 @@
#!/usr/bin/env node
/**
* ObsiGate Frontend unit tests (pure functions, no DOM required).
* Usage: node tests/frontend/unit.test.mjs
*/
import { strict as assert } from 'assert';
// ── Test escapeHtml (from utils.js) ────────────────────────────────────────
// We test the logic directly since utils.js imports from state.js which needs DOM
const escapeHtml = (str) => {
if (!str) return '';
return String(str).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
};
function testEscapeHtml() {
assert.strictEqual(escapeHtml(''), '');
assert.strictEqual(escapeHtml(null), '');
assert.strictEqual(escapeHtml(undefined), '');
assert.strictEqual(escapeHtml('hello'), 'hello');
assert.strictEqual(escapeHtml('<script>'), '&lt;script&gt;');
assert.strictEqual(escapeHtml('a & b'), 'a &amp; b');
assert.strictEqual(escapeHtml('"quoted"'), '&quot;quoted&quot;');
assert.strictEqual(escapeHtml('<a href="x">&</a>'), '&lt;a href=&quot;x&quot;&gt;&amp;&lt;/a&gt;');
console.log(' ✓ escapeHtml');
}
// ── Test state object structure ────────────────────────────────────────────
// Replicate state.js structure for testing
const expectedStateKeys = [
'APP_VERSION', 'currentVault', 'currentPath', 'allVaults', 'selectedContextVault',
'searchTimeout', 'searchAbortController', 'advancedSearchOffset', 'advancedSearchTotal',
'advancedSearchSort', 'advancedSearchLastQuery', 'suggestAbortController',
'dropdownActiveIndex', 'dropdownItems', 'currentSearchId', 'selectedTags',
'searchCaseSensitive', 'searchWholeWord', 'searchRegex', 'searchFilterVisible',
'SEARCH_HISTORY_KEY', 'MAX_HISTORY_ENTRIES', 'SUGGEST_DEBOUNCE_MS',
'ADVANCED_SEARCH_LIMIT', 'MIN_SEARCH_LENGTH', 'SEARCH_TIMEOUT_MS',
'showingSource', 'cachedRawSource', 'editorView', 'editorVault', 'editorPath',
'fallbackEditorEl', '_iconDebounceTimer', 'outlineObserver', 'activeHeadingId',
'headingsCache', 'rightSidebarVisible', 'rightSidebarWidth',
'sidebarFilterCaseSensitive', 'activeSidebarTab', 'filterDebounce', 'vaultSettings',
];
function testStateKeys() {
const state = {
APP_VERSION: "1.5.0", currentVault: null, currentPath: null, allVaults: [],
selectedContextVault: "all", searchTimeout: null, searchAbortController: null,
advancedSearchOffset: 0, advancedSearchTotal: 0, advancedSearchSort: "relevance",
advancedSearchLastQuery: "", suggestAbortController: null, dropdownActiveIndex: -1,
dropdownItems: [], currentSearchId: 0, selectedTags: [], searchCaseSensitive: false,
searchWholeWord: false, searchRegex: false, searchFilterVisible: false,
SEARCH_HISTORY_KEY: "obsigate_search_history", MAX_HISTORY_ENTRIES: 50,
SUGGEST_DEBOUNCE_MS: 150, ADVANCED_SEARCH_LIMIT: 50, MIN_SEARCH_LENGTH: 2,
SEARCH_TIMEOUT_MS: 30000, showingSource: false, cachedRawSource: null,
editorView: null, editorVault: null, editorPath: null, fallbackEditorEl: null,
_iconDebounceTimer: null, outlineObserver: null, activeHeadingId: null,
headingsCache: [], rightSidebarVisible: true, rightSidebarWidth: 280,
sidebarFilterCaseSensitive: false, activeSidebarTab: "vaults", filterDebounce: null,
vaultSettings: {},
};
for (const key of expectedStateKeys) {
assert.ok(key in state, `State key missing: ${key}`);
}
// Verify mutability
state.currentVault = 'test';
assert.strictEqual(state.currentVault, 'test');
state.rightSidebarVisible = false;
assert.strictEqual(state.rightSidebarVisible, false);
console.log(' ✓ state object — all %d keys present and mutable', expectedStateKeys.length);
}
// ── Test module file structure ─────────────────────────────────────────────
import { readdirSync, readFileSync } from 'fs';
import { join, dirname } from 'path';
import { fileURLToPath } from 'url';
import { execSync } from 'child_process';
const __dirname = dirname(fileURLToPath(import.meta.url));
const JS_DIR = join(__dirname, '../../frontend/js');
function testAllModulesParse() {
const files = readdirSync(JS_DIR).filter(f => f.endsWith('.js') && f !== 'sidebar_raw.js');
let ok = 0, fail = 0;
for (const file of files) {
try {
execSync(`node --check "${join(JS_DIR, file)}"`, { stdio: 'pipe' });
ok++;
} catch {
console.error(`${file} — syntax error`);
fail++;
}
}
assert.strictEqual(fail, 0, `${fail} module(s) have syntax errors`);
console.log(` ✓ All ${ok} modules parse without syntax errors`);
}
function testModulesHaveImports() {
const files = readdirSync(JS_DIR).filter(f => f.endsWith('.js') && f !== 'sidebar_raw.js');
const expected = [
{ file: 'state.js', reason: 'export-only module' },
];
const expectNoImport = new Set(expected.map(e => e.file));
for (const file of files) {
const content = readFileSync(join(JS_DIR, file), 'utf-8');
const hasExport = /^export\s/m.test(content);
const hasImport = /^import\s/m.test(content);
if (!expectNoImport.has(file)) {
assert.ok(hasImport, `${file} should have at least one import`);
}
if (file !== 'state.js' && file !== 'app.js') {
assert.ok(hasExport, `${file} should have at least one export`);
}
}
console.log(' ✓ All modules have imports and exports (except state.js)');
}
// ── Run all tests ──────────────────────────────────────────────────────────
async function main() {
let passed = 0, failed = 0;
const tests = [
['escapeHtml', testEscapeHtml],
['state keys', testStateKeys],
['module syntax', testAllModulesParse],
['module structure', testModulesHaveImports],
];
for (const [name, fn] of tests) {
try {
fn();
passed++;
} catch (err) {
console.error(`${name}: ${err.message}`);
failed++;
}
}
console.log(`\n${passed} passed, ${failed} failed`);
process.exit(failed > 0 ? 1 : 0);
}
main();

View File

@ -0,0 +1,191 @@
#!/usr/bin/env node
/**
* ObsiGate Frontend import/export validator.
* Runs in CI to catch missing exports, broken imports, and syntax errors.
* Usage: node tests/frontend/validate-imports.mjs
*/
import { readFileSync, readdirSync } from 'fs';
import { join, dirname } from 'path';
import { fileURLToPath } from 'url';
const __dirname = dirname(fileURLToPath(import.meta.url));
const JS_DIR = join(__dirname, '../../frontend/js');
// ── Step 1: Collect all exports from every module ──────────────────────────
const allExports = {};
function collectExports(filePath, modName) {
const content = readFileSync(filePath, 'utf-8');
const lines = content.split('\n');
const exports = new Set();
// Handle multi-line export { ... } blocks
let inExportBlock = false;
let exportBlockText = '';
for (const line of lines) {
// Start of multi-line export block
if (/^export\s*\{/.test(line) && !/\}/.test(line)) {
inExportBlock = true;
exportBlockText = line;
continue;
}
if (inExportBlock) {
exportBlockText += ' ' + line.trim();
if (/\}/.test(line)) {
inExportBlock = false;
const m = exportBlockText.match(/^export\s*\{([^}]+)\}/);
if (m) {
for (const name of m[1].split(',')) {
const n = name.trim().replace(/\s+as\s+\w+.*/, '').trim();
if (n && n !== '') exports.add(n);
}
}
exportBlockText = '';
}
continue;
}
// export const/let/function/async function X
let m = line.match(/^export\s+(?:const|let|function|async\s+function|class)\s+(\w+)/);
if (m) exports.add(m[1]);
// Single-line export { a, b }
m = line.match(/^export\s*\{([^}]+)\}/);
if (m) {
for (const name of m[1].split(',')) {
const n = name.trim().replace(/\s+as\s+.*/, '');
if (n) exports.add(n);
}
}
// export { a } from './x.js'
m = line.match(/^export\s*\{([^}]+)\}\s*from\s*['"]\.\/(\w+\.js)['"]/);
if (m) {
const source = m[2];
for (const name of m[1].split(',')) {
const n = name.trim().replace(/\s+as\s+.*/, '').trim();
if (n) exports.add(n);
}
// Re-exports: verify source actually exports these
if (allExports[source]) {
for (const name of m[1].split(',')) {
const n = name.trim().replace(/\s+as\s+.*/, '').trim();
if (n && !allExports[source].has(n)) {
errors.push(`${modName}: re-exports '${n}' but ${source} doesn't export it`);
}
}
}
}
}
allExports[modName] = exports;
}
// ── Step 2: Check all imports resolve to actual exports ────────────────────
const errors = [];
function checkImports(filePath, modName) {
const content = readFileSync(filePath, 'utf-8');
const lines = content.split('\n');
for (const line of lines) {
// import { a, b } from './source.js'
let m = line.match(/^import\s*\{([^}]+)\}\s*from\s*['"]\.\/(\w+\.js)['"]/);
if (m) {
const source = m[2];
const names = m[1].split(',').map(n => n.trim().split(/\s+as\s+/)[0].trim());
if (!allExports[source]) {
errors.push(`${modName}: imports from ${source} but couldn't read that file`);
continue;
}
for (const name of names) {
if (!allExports[source].has(name)) {
errors.push(`${modName}: imports '${name}' from ${source} but it's NOT exported`);
}
}
}
// import * as NS from './source.js'
m = line.match(/^import\s+\*\s+as\s+(\w+)\s+from\s*['"]\.\/(\w+\.js)['"]/);
if (m) {
const ns = m[1];
const source = m[2];
if (!allExports[source]) {
errors.push(`${modName}: namespace imports from ${source} but couldn't read that file`);
continue;
}
// Check all NS.xxx usages in this file
const nsUsage = new RegExp(`\\b${ns}\\.(\\w+)`, 'g');
let usageMatch;
while ((usageMatch = nsUsage.exec(content)) !== null) {
const accessed = usageMatch[1];
if (!allExports[source].has(accessed)) {
errors.push(`${modName}: uses ${ns}.${accessed} but ${source} doesn't export '${accessed}'`);
}
}
}
}
}
// ── Main ───────────────────────────────────────────────────────────────────
const files = readdirSync(JS_DIR).filter(f => f.endsWith('.js') && f !== 'sidebar_raw.js');
// Phase 1: collect all exports
for (const file of files) {
collectExports(join(JS_DIR, file), file);
}
// Phase 2: verify all imports
for (const file of files) {
checkImports(join(JS_DIR, file), file);
}
// ── Step 3: Check for const reassignment patterns ──────────────────────────
for (const file of files) {
const content = readFileSync(join(JS_DIR, file), 'utf-8');
const lines = content.split('\n');
// Find all imported names
const importedNames = new Set();
for (const line of lines) {
const m = line.match(/^import\s*\{([^}]+)\}\s*from/);
if (m) {
for (const name of m[1].split(',')) {
importedNames.add(name.trim().split(/\s+as\s+/)[0].trim());
}
}
}
// Check if any imported name is reassigned
for (const line of lines) {
for (const name of importedNames) {
// Check for: name = (not ===, !==, ==, !=)
if (new RegExp(`^\\s*${name}\\s*=[^=]`).test(line) ||
new RegExp(`^\\s*${name}\\s*=\\s*function`).test(line) ||
new RegExp(`^\\s*${name}\\s*=\\s*async`).test(line) ||
new RegExp(`^\\s*${name}\\s*=\\s*\\{`).test(line) ||
new RegExp(`^\\s*${name}\\s*=\\s*\\[`).test(line)) {
errors.push(`${file}:${lines.indexOf(line) + 1} — imported '${name}' is reassigned (const violation)`);
}
}
}
}
// ── Report ─────────────────────────────────────────────────────────────────
if (errors.length > 0) {
console.error(`\n${errors.length} frontend validation error(s):\n`);
for (const err of errors) {
console.error(`${err}`);
}
console.error('');
process.exit(1);
} else {
console.log(`✅ All ${files.length} modules validated — ${Object.values(allExports).reduce((s, e) => s + e.size, 0)} exports, 0 errors`);
process.exit(0);
}