aboutsummaryrefslogtreecommitdiff
path: root/scripts/newos4-maintain.py
blob: c28fb8bdead2fb3cfef43360dd659fcd3a231750 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
#!/usr/bin/env python3
"""newOS4 maintenance: drift, bundles, syntax, perms, data hygiene, live health.
Safe fixes only with --fix. Never touches nginx, services, sudo, or user content."""
import glob, json, os, re, subprocess, sys
from datetime import datetime, timezone

ROOT = '/var/www/webx11.duckdns.org/spaces/newos4'
WEB = 'https://webx11.duckdns.org/spaces/newos4'
FIX = '--fix' in sys.argv
DEEP = '--deep' in sys.argv
issues = []
def add(l, m): issues.append((l, m))
def run(cmd, **kw): return subprocess.run(cmd, capture_output=True, text=True, **kw)
def sh(cmd): return run(cmd, shell=True).stdout.strip()

def check_versions():
    html = open(os.path.join(ROOT, 'main.html'), encoding='utf-8').read()
    loader = open(os.path.join(ROOT, 'modules/core/module-loader.js'), encoding='utf-8').read()
    m = re.search(r"const LATEST_VER\s*=\s*'([^']+)'", loader)
    ver = m.group(1) if m else '?'
    n = html.count(ver)
    add('PASS' if n == 3 else 'FAIL', f'version {ver} x{n} in main.html (expect 3)')

def syntax_failures():
    bad = []
    for p in glob.glob(os.path.join(ROOT, 'modules/core/*.js')) + glob.glob(os.path.join(ROOT, 'modules/ext/*.js')):
        if os.path.basename(p) in ('core-bundle.js', 'critical-ext-bundle.js'): continue
        if run(['node', '--check', p]).returncode: bad.append(os.path.basename(p))
    return bad

def check_bundles(bad_syntax=None):
    """Rebuild only when every module parses.

    rebuild-bundles.py concatenates blindly (no validation), so a module with a
    syntax error would be baked straight into the served core-bundle.js. Since
    --fix now runs daily, the rebuild is gated on check_syntax and the produced
    bundles are re-checked before the run is called clean.
    """
    paths = ('modules/core/core-bundle.js', 'modules/ext/critical-ext-bundle.js')
    before = {p: sh(f'md5sum {p}') for p in paths}
    if not FIX:
        add('PASS', 'bundle check skipped (use --fix)'); return
    if bad_syntax is None: bad_syntax = syntax_failures()
    if bad_syntax:
        add('FAIL', 'bundles rebuild BLOCKED: syntax fail in ' + ', '.join(bad_syntax[:5])); return
    r = run([sys.executable, 'scripts/rebuild-bundles.py'], cwd=ROOT)
    if r.returncode:
        add('FAIL', 'bundles FAILED'); return
    invalid = [p for p in paths if run(['node', '--check', os.path.join(ROOT, p)]).returncode]
    if invalid:
        add('FAIL', 'bundles rebuilt but INVALID: ' + ', '.join(invalid)); return
    after = {p: sh(f'md5sum {p}') for p in paths}
    changed = [p for p in paths if before[p] != after[p]]
    add('WARN' if changed else 'PASS',
        'bundles ' + ('rebuilt: ' + ', '.join(changed) if changed else 'clean'))

def check_syntax(bad=None):
    bad = syntax_failures() if bad is None else bad
    add('PASS' if not bad else 'FAIL', 'syntax ' + ('OK' if not bad else 'fail: ' + ', '.join(bad)))

def check_perms():
    targets = glob.glob(os.path.join(ROOT, 'course/*.json')) + glob.glob(os.path.join(ROOT, 'course/chapters/*.json')) \
        + [os.path.join(ROOT, 'modules/ext/course.js'), os.path.join(ROOT, 'course.html'), os.path.join(ROOT, 'api/course/event.php')]
    bad = []
    for p in targets:
        if not os.path.exists(p): continue
        if (os.stat(p).st_mode & 0o777) != 0o644 or sh(f'stat -c %G {p}') != 'www-data':
            if FIX:
                os.chmod(p, 0o644); sh(f'chgrp www-data {p}')
            else: bad.append(os.path.basename(p))
    add('PASS' if not bad else ('WARN' if FIX else 'FAIL'), 'perms ' + ('clean' if not bad else ('fixed' if FIX else 'bad: ' + ', '.join(bad[:5]))))

def check_index():
    idxp = os.path.join(ROOT, 'modules-index.json')
    atlas = json.load(open(os.path.join(ROOT, 'course/atlas.json')))
    idx = json.load(open(idxp))
    index_cmds = set(c for m in idx.get('modules', {}).values() for c in m.get('commands', []))
    missing = sorted(c for c, e in atlas.get('commands', {}).items() if not e.get('builtin') and c not in index_cmds)
    if not missing:
        add('PASS', f'modules-index covers {len(index_cmds)} commands'); return
    add('WARN', f'modules-index missing {len(missing)}: ' + ', '.join(missing[:5]))
    if not FIX: return
    for name, m in atlas['modules'].items():
        e = idx['modules'].get(name, {'name': name, 'file': m['file'], 'type': 'core' if m['tier'] == 'core-bundle' else 'ext',
                                      'class': '', 'auto_load': m['tier'] != 'ext-manual', 'description': ''})
        e.update({'commands': m['commands'], 'file': m['file'], 'tier': m['tier']})
        idx['modules'][name] = e
    idx['version'] = datetime.now(timezone.utc).strftime('%Y-%m-%d') + '-atlas'
    tmp = idxp + '.tmp'
    with open(tmp, 'w', encoding='utf-8') as f: json.dump(idx, f, ensure_ascii=False, indent=1)
    os.replace(tmp, idxp); os.chmod(idxp, 0o644); sh(f'chgrp www-data {idxp}')
    add('PASS', 'modules-index regenerated')

def check_data():
    err = os.path.join(ROOT, 'data/debug/errors.json')
    if os.path.exists(err) and os.path.getsize(err) > 5 * 1024 * 1024:
        if FIX:
            arc = os.path.join(ROOT, 'data/debug/archive'); os.makedirs(arc, exist_ok=True)
            os.replace(err, os.path.join(arc, 'errors-' + datetime.now().strftime('%Y%m') + '.json'))
            open(err, 'w').write('[]'); os.chmod(err, 0o664); sh(f'chgrp www-data {err}')
            add('PASS', 'errors.json rotated')
        else: add('WARN', 'errors.json >5MB')
    else: add('PASS', 'debug data OK')

def check_live():
    for url in (f'{WEB}/main.html', f'{WEB}/course.html', f'{WEB}/course/course.json', f'{WEB}/modules/core/core-bundle.js'):
        code = sh(f"curl -s -o /dev/null -w '%{{http_code}}' '{url}'")
        add('PASS' if code == '200' else 'FAIL', f'HTTP {code} {url.replace(WEB, "")}')

def check_atlas():
    p = os.path.join(ROOT, 'course/atlas.json')
    before = (json.load(open(p)).get('coverage', {}).get('commands') if os.path.exists(p) else None)
    r = run([sys.executable, 'scripts/gen-course-atlas.py'], cwd=ROOT)
    after = (json.load(open(p)).get('coverage', {}).get('commands') if os.path.exists(p) else None)
    add('PASS' if r.returncode == 0 else 'FAIL',
        f'atlas {after} commands' + (' (refreshed from ' + str(before) + ')' if before != after else ''))

def check_course():
    r = run([sys.executable, 'scripts/course-validate.py'], cwd=ROOT)
    add('PASS' if r.returncode == 0 else 'FAIL', 'course ' + ('valid' if r.returncode == 0 else 'INVALID: ' + r.stdout[-160:]))

def check_help_coverage():
    """Every command the code registers must appear in help.html (2026-10-22).

    help.html had a 74-command backlog because nothing compared the two. This
    check makes the gap visible on every maintenance run.
    """
    cmds, term = set(), open(os.path.join(ROOT, 'modules/core/terminal.js'), encoding='utf-8').read()
    for m in re.finditer(r'this\._baseWhitelist = \[(.*?)\];', term, re.S):
        cmds.update(re.findall(r"'([^']+)'", m.group(1)))
    for m in re.finditer(r'const internals = \[(.*?)\];', term, re.S):
        cmds.update(re.findall(r"'([^']+)'", m.group(1)))
    cmds.update(re.findall(r"cmd === ['\"]([a-z0-9_-]+)['\"]", term))
    for p in glob.glob(os.path.join(ROOT, 'modules/**/*.js'), recursive=True):
        if 'bundle' in p or '/test/' in p or '.bkp' in p:
            continue
        src = open(p, encoding='utf-8', errors='ignore').read()
        cmds.update(re.findall(r"commands\[['\"]([a-z0-9_-]+)['\"]\]\s*=", src))
    doc = open(os.path.join(ROOT, 'help.html'), encoding='utf-8').read()
    documented = set()
    for tok in re.findall(r'<code>([^<]+)</code>', doc):
        first = tok.replace('&lt;', ' ').replace('&gt;', ' ').split()
        if first and re.fullmatch(r'[a-z][a-z0-9_-]{0,40}', first[0].lstrip('./')):
            documented.add(first[0].lstrip('./'))
    missing = sorted(cmds - documented)
    add('PASS' if not missing else 'WARN',
        f'help coverage {len(cmds) - len(missing)}/{len(cmds)} commands'
        + ('' if not missing else f' — undocumented: {", ".join(missing[:8])}'))

def check_regression_tests():
    """Every node-runnable test under modules/test/ must pass (2026-10-27).

    The v4.6.102 checkpoint regression was written but no job executed it, so drift could ship
    silently. Two header conventions exist: '// ... run: node' and '// node modules/test/x.js'.
    test-suite.js starts with a class (browser-only) and is correctly skipped.
    """
    tests, failed = [], []
    for p in sorted(glob.glob(os.path.join(ROOT, 'modules/test/test-*.js'))):
        head = ''.join(open(p, encoding='utf-8', errors='ignore').readlines()[:3])
        if 'run: node' not in head and not head.startswith('// node modules/test/'):
            continue
        tests.append(p)
        try:
            r = subprocess.run(['node', p], cwd=ROOT, capture_output=True, text=True, timeout=120)
        except subprocess.TimeoutExpired:
            failed.append(os.path.basename(p) + ': timeout')
            continue
        if r.returncode != 0:
            lines = (r.stdout or r.stderr).strip().splitlines() or ['no output']
            failed.append(os.path.basename(p) + ': ' + lines[-1][:120])
    add('PASS' if not failed else 'FAIL',
        'node tests %d/%d pass' % (len(tests) - len(failed), len(tests))
        + ('' if not failed else ' — ' + '; '.join(failed[:3])))

def check_links():
    if not DEEP: return
    broken = []
    for page in ('main.html', 'course.html', 'help.html', 'modules.html', 'guide.html'):
        p = os.path.join(ROOT, page)
        if not os.path.exists(p): continue
        for href in re.findall(r'(?:href|src)="([^"#]+)"', open(p, encoding='utf-8').read()):
            if any(x in href for x in ("'", '+', '{', '}')): continue
            if href.startswith(('http', '//', 'mailto:', 'javascript:', 'data:', '/api/')): continue
            target = os.path.normpath(os.path.join(ROOT, href.split('?')[0]))
            if not os.path.exists(target): broken.append(f'{page}:{href}')
    add('PASS' if not broken else 'WARN', 'links ' + ('OK' if not broken else f'{len(broken)} broken (first: {broken[0]})'))

def main():
    os.chdir(ROOT)
    bad = syntax_failures()          # computed once, gates the bundle rebuild
    check_versions(); check_syntax(bad); check_regression_tests(); check_bundles(bad); check_perms(); check_index(); check_data(); check_live(); check_atlas(); check_course(); check_help_coverage(); check_links()
    fails = [m for l, m in issues if l == 'FAIL']
    print('newOS4 maintenance — ' + datetime.now(timezone.utc).strftime('%Y-%m-%d %H:%MZ') + (' [fix]' if FIX else '') + (' [deep]' if DEEP else ''))
    for l, m in issues: print(f'{l}: {m}')
    print('maintenance result: ' + ('FAIL' if fails else 'OK'))
    print('needs OK: ' + ('none' if not fails else '; '.join(fails)[:400]))
    return 1 if fails else 0

if __name__ == '__main__':
    sys.exit(main())