@bongos/core 1.20.28 → 1.20.30

package/tests/upgrade_outcome.mjs

@@ -0,0 +1,129 @@
+// tests/upgrade_outcome.mjs — every failed core move gets a class and honest wording
+// (task 1004446, goal 1000090 deploy self-heal).
+//
+// WHAT IS AT RISK. The deploy page said "failed and was rolled back" for every exit of
+// `bongos upgrade`, including refusals that changed nothing and rollbacks that themselves
+// failed. The rest of the self-heal chain (retry later, fix it, escalate) keys on the class
+// this file assigns, so a mislabel there is a retry of something that must not be retried,
+// or an automatic "fix" for something that needed a person.
+//
+// Run:  node tests/upgrade_outcome.mjs
+
+import { strict as assert } from 'node:assert';
+import { createRequire } from 'node:module';
+import {
+  outcomeLine, parseOutcomeLine, upgradeReason, upgradeStage, classifyFailure, runnerReason,
+  describeUpgradeFailure, FAILURE_CLASSES, REASON_CLASS, STAGES, OUTCOME_TAG,
+} from '../scripts/gds/upgrade-outcome.js';
+
+const require = createRequire(import.meta.url);
+const R = require('../scripts/gds/provision-core-upgrade.js');
+
+let passed = 0;
+let failed = 0;
+const t = async (name, fn) => {
+  try { await fn(); passed += 1; console.log(`  PASS  ${name}`); }
+  catch (e) { failed += 1; console.log(`  FAIL  ${name}\n        ${e.message}`); }
+};
+
+// Each row: an upgrade.js failure result as runUpgrade returns it → the stage, reason and
+// class it must get. These are the branches of runUpgrade's failure table (upgrade.js).
+const OK_RB = { restoreOk: true, reinstallOk: true, restartOk: true, healthOk: true };
+const TABLE = [
+  ['downgrade refusal', { ok: false, downgrade: true, error: 'refusing to DOWNGRADE: --to 1.19.1 is older' }, 'refused', 'downgrade', 'needs_decision'],
+  ['already on the target', { ok: false, error: 'already on 1.20.1 (pass --force to re-run the steps anyway)' }, 'refused', 'already_on', 'unknown'],
+  ['dirty working tree', { ok: false, error: 'working tree not clean — commit/stash first, or pass --force.\n M package.json' }, 'refused', 'dirty_tree', 'known_wedge'],
+  ['module pre-check', { ok: false, error: 'module pre-check failed: game incompatible with core 1.20.1' }, 'refused', 'module_incompatible', 'needs_decision'],
+  ['database unresolvable', { ok: false, error: 'cannot determine which database to migrate.\n    Set PGDATABASE' }, 'refused', 'db_unresolvable', 'unknown'],
+  ['database identity', { ok: false, error: 'database "cb" is not reachable as the current user: role "root" does not exist' }, 'refused', 'db_identity', 'unknown'],
+  ['artist gate hold', { ok: false, artistGate: true, error: 'a visual review is holding this deploy' }, 'refused', 'artist_gate', 'needs_decision'],
+  ['health url missing', { ok: false, error: 'post-restart health check is mandatory for a bump that restarts the service' }, 'refused', 'health_url_missing', 'unknown'],
+  ['npm install failed, rolled back', { ok: false, error: 'npm install failed (exit 1)', rolledBack: true, rollback: OK_RB }, 'rolled_back', 'npm_install', 'transient'],
+  ['disk full, rolled back', { ok: false, error: 'npm install failed (ENOSPC: no space left on device)', rolledBack: true, rollback: OK_RB }, 'rolled_back', 'disk_full', 'known_wedge'],
+  ['integrity pin mismatch', { ok: false, error: 'integrity pin MISMATCH (side-car) — installed core does not match its pin: x', rolledBack: true, rollback: OK_RB }, 'rolled_back', 'integrity_pin', 'unknown'],
+  ['migrate failed', { ok: false, error: 'migrate failed (exit 3)', rolledBack: true, rollback: OK_RB }, 'rolled_back', 'migrate', 'unknown'],
+  ['restart failed', { ok: false, error: 'restart failed (exit 1) — the instance is still running the previous core', rolledBack: true, rollback: OK_RB }, 'rolled_back', 'restart', 'unknown'],
+  ['health failed', { ok: false, error: 'health check failed after restart — rolled back to 1.19.1081', rolledBack: true, rollback: OK_RB }, 'rolled_back', 'health', 'unknown'],
+  ['served version unchanged', { ok: false, error: 'served core version did not change (still 1.19.1081, expected 1.20.1) — rolled back', rolledBack: true, rollback: OK_RB }, 'rolled_back', 'health', 'unknown'],
+  ['ROLLBACK FAILED (health still bad)', { ok: false, error: 'health check failed after restart — rolled back', rolledBack: true, rollback: { ...OK_RB, healthOk: false } }, 'rollback_failed', 'rollback_failed', 'unknown'],
+  ['ROLLBACK FAILED (reinstall)', { ok: false, error: 'migrate failed (exit 3)', rolledBack: true, rollback: { ...OK_RB, reinstallOk: false } }, 'rollback_failed', 'rollback_failed', 'unknown'],
+];
+
+console.log('\nevery branch of the upgrade failure table:');
+
+for (const [name, res, stage, reason, cls] of TABLE) {
+  await t(`${name} → ${stage} / ${reason} / ${cls}`, () => {
+    const o = parseOutcomeLine(outcomeLine(res));
+    assert.deepEqual(o, { stage, reason });
+    assert.equal(classifyFailure(o.reason).class, cls);
+  });
+}
+
+console.log('\nthe vocabulary:');
+
+await t('every reason maps to one of the four classes', () => {
+  for (const [r, c] of Object.entries(REASON_CLASS)) assert.ok(FAILURE_CLASSES.includes(c), `${r} → ${c}`);
+});
+
+await t('an unlisted reason is unknown — the safe direction', () => {
+  assert.deepEqual(classifyFailure('something_new'), { class: 'unknown', reason: 'unknown' });
+  assert.deepEqual(classifyFailure(undefined), { class: 'unknown', reason: 'unknown' });
+  assert.deepEqual(classifyFailure('__proto__'), { class: 'unknown', reason: 'unknown' });
+});
+
+await t('the migration CHECK carries exactly the four classes', async () => {
+  const { readFileSync } = await import('node:fs');
+  const sql = readFileSync(new URL('../modules/provisioning/migrations/provisioning_030_intent_failure_class.sql', import.meta.url), 'utf8');
+  for (const c of FAILURE_CLASSES) assert.match(sql, new RegExp(`'${c}'`));
+});
+
+await t('a stage is only what upgrade.js reports: no rollback flag means nothing moved', () => {
+  assert.equal(upgradeStage({ ok: false, error: 'x' }), 'refused');
+  assert.equal(upgradeStage({ ok: false, rolledBack: true, rollback: OK_RB }), 'rolled_back');
+  assert.equal(upgradeStage({ ok: false, rolledBack: true, rollback: { restartOk: false } }), 'rollback_failed');
+  assert.equal(upgradeReason(null), 'unknown');
+});
+
+await t('parseOutcomeLine takes the LAST line, and refuses anything off-vocabulary', () => {
+  const two = `${OUTCOME_TAG} {"stage":"refused","reason":"dirty_tree"}\nnoise\n${OUTCOME_TAG} {"stage":"rolled_back","reason":"migrate"}\n`;
+  assert.deepEqual(parseOutcomeLine(two), { stage: 'rolled_back', reason: 'migrate' });
+  assert.equal(parseOutcomeLine('no tag here'), null);
+  assert.equal(parseOutcomeLine(`${OUTCOME_TAG} {"stage":"exploded","reason":"x"}`), null);
+  assert.equal(parseOutcomeLine(`${OUTCOME_TAG} {"stage":"refused","reason":"<script>"}`), null);
+  assert.equal(parseOutcomeLine(`${OUTCOME_TAG} not json`), null);
+  assert.deepEqual([...STAGES], ['refused', 'rolled_back', 'rollback_failed']);
+});
+
+await t('the runner\'s own refusals get their reason from targetFault\'s sentences', () => {
+  assert.equal(runnerReason(R.targetFault('1.20.1', [], '1.19.1', 'patch', () => true)), 'registry_unreadable');
+  assert.equal(runnerReason(R.targetFault('1.20.1', ['1.19.1'], '1.19.1', 'patch', () => true)), 'not_published');
+  assert.equal(runnerReason(R.targetFault('1.20.1', ['1.20.1'], null, 'patch', () => true)), 'installed_unreadable');
+  assert.equal(runnerReason(R.targetFault('1.20.1', ['1.20.1'], '1.19.1', 'patch', () => false)), 'outside_channel');
+});
+
+console.log('\nthe wording says what happened, and no more:');
+
+await t('a refusal never says "rolled back"', () => {
+  const s = describeUpgradeFailure('1.20.1', { stage: 'refused', reason: 'dirty_tree' }, 'working tree not clean');
+  assert.doesNotMatch(s, /rolled back/);
+  assert.match(s, /refused before anything changed/);
+});
+
+await t('a real rollback says so', () => {
+  assert.match(describeUpgradeFailure('1.20.1', { stage: 'rolled_back', reason: 'migrate' }, 'migrate failed'), /failed and was rolled back/);
+});
+
+await t('a failed rollback says the project may be down and needs a person', () => {
+  const s = describeUpgradeFailure('1.20.1', { stage: 'rollback_failed', reason: 'rollback_failed' }, '');
+  assert.match(s, /rollback did not finish/);
+  assert.match(s, /needs a person/);
+});
+
+await t('no outcome line claims nothing about a rollback', () => {
+  const s = describeUpgradeFailure('1.20.1', null, 'sudo: unknown user bongos-test4');
+  assert.doesNotMatch(s, /rolled back/);
+  assert.match(s, /did not report how far it got/);
+});
+
+console.log(`\nupgrade_outcome: ${passed} passed, ${failed} failed`);
+if (failed) process.exit(1);