Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
/**
* Unit tests for scripts/postinstall.js (node:test — no jest, no deps).
* Run: `npm run test:scripts`.
*
* The spawn is injected, so every branch (success, non-zero exit, spawn error, signal, fail-fast
* ordering) is exercised without a real `npm run dashboard:ci`.
*/
'use strict';
const test = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const os = require('os');
const path = require('path');
const { sanitizeEnv, planSteps, failureReason, run } = require('./postinstall.js');
const OK = { status: 0, signal: null, error: null };
/** Every patcher that actually ships, so the order test below cannot be told a stale list. */
const PATCHERS_ON_DISK = fs
.readdirSync(__dirname)
.filter(f => f.startsWith('patch-') && f.endsWith('.js') && !f.endsWith('.spec.js'))
.sort();
/** The sequence planSteps must keep. Every patcher on disk has to appear here; asserted below. */
const EXPECTED_PATCHER_ORDER = [
'patch-wwebjs-201832.js',
'patch-wwebjs-newsletter-preview.js',
'patch-wwebjs-status.js',
'patch-wwebjs-ready-sync.js',
'patch-wwebjs-participant-arity.js',
'patch-wwebjs-block.js',
'patch-wwebjs-group-description.js',
'patch-wwebjs-media-id.js',
'patch-wwebjs-send-error.js',
'patch-baileys-appstate.js',
'patch-baileys-newsletter-create.js',
'patch-baileys-pairing.js',
'patch-wwebjs-puppeteer.js',
];
/** Bare temp dir optionally holding a dashboard/ and/or the patch scripts. */
function makeRoot({
dashboard = false,
patchers = [],
patcher = false,
previewPatcher = false,
statusPatcher = false,
readySyncPatcher = false,
participantArityPatcher = false,
baileysPatcher = false,
baileysNewsletterPatcher = false,
} = {}) {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'openwa-postinstall-'));
if (dashboard) fs.mkdirSync(path.join(root, 'dashboard'));
if (
patchers.length ||
patcher ||
previewPatcher ||
statusPatcher ||
readySyncPatcher ||
participantArityPatcher ||
baileysPatcher ||
baileysNewsletterPatcher
) {
fs.mkdirSync(path.join(root, 'scripts'));
}
for (const name of patchers) {
fs.writeFileSync(path.join(root, 'scripts', name), '// stub\n');
}
if (patcher) {
fs.writeFileSync(path.join(root, 'scripts', 'patch-wwebjs-201832.js'), '// stub\n');
}
if (previewPatcher) {
fs.writeFileSync(path.join(root, 'scripts', 'patch-wwebjs-newsletter-preview.js'), '// stub\n');
}
if (statusPatcher) {
fs.writeFileSync(path.join(root, 'scripts', 'patch-wwebjs-status.js'), '// stub\n');
}
if (readySyncPatcher) {
fs.writeFileSync(path.join(root, 'scripts', 'patch-wwebjs-ready-sync.js'), '// stub\n');
}
if (participantArityPatcher) {
fs.writeFileSync(path.join(root, 'scripts', 'patch-wwebjs-participant-arity.js'), '// stub\n');
}
if (baileysPatcher) {
fs.writeFileSync(path.join(root, 'scripts', 'patch-baileys-appstate.js'), '// stub\n');
}
if (baileysNewsletterPatcher) {
fs.writeFileSync(path.join(root, 'scripts', 'patch-baileys-newsletter-create.js'), '// stub\n');
}
return root;
}
/** spawnSync stand-in: records calls, replays the queued results in order. */
function fakeSpawn(results) {
const calls = [];
let i = 0;
const spawn = (command, args, options) => {
calls.push({ command, args, options });
return results[Math.min(i++, results.length - 1)];
};
return { calls, spawn };
}
test('planSteps: empty root plans nothing', () => {
assert.deepEqual(planSteps(makeRoot()), []);
});
test('planSteps: dashboard only plans the dashboard install (shell, inherited stdio)', () => {
const root = makeRoot({ dashboard: true });
const steps = planSteps(root);
assert.equal(steps.length, 1);
assert.equal(steps[0].command, 'npm ci');
assert.equal(steps[0].options.shell, true);
assert.equal(steps[0].options.stdio, 'inherit');
assert.equal(steps[0].options.cwd, path.join(root, 'dashboard'));
});
test('planSteps: patcher only plans the best-effort backport via the current node', () => {
const steps = planSteps(makeRoot({ patcher: true }));
assert.equal(steps.length, 1);
assert.equal(steps[0].command, process.execPath);
assert.match(steps[0].args[0], /patch-wwebjs-201832\.js$/);
assert.deepEqual(steps[0].args.slice(1), ['--best-effort']);
});
test('planSteps: newsletter preview patcher plans its own best-effort backport', () => {
const steps = planSteps(makeRoot({ previewPatcher: true }));
assert.equal(steps.length, 1);
assert.equal(steps[0].command, process.execPath);
assert.match(steps[0].args[0], /patch-wwebjs-newsletter-preview\.js$/);
assert.deepEqual(steps[0].args.slice(1), ['--best-effort']);
});
test('planSteps: both present plans dashboard first, patcher second', () => {
const steps = planSteps(makeRoot({ dashboard: true, patcher: true }));
assert.equal(steps.length, 2);
assert.equal(steps[0].command, 'npm ci');
assert.equal(steps[1].command, process.execPath);
});
test('planSteps: status patcher plans its own best-effort repair', () => {
const steps = planSteps(makeRoot({ statusPatcher: true }));
assert.equal(steps.length, 1);
assert.equal(steps[0].command, process.execPath);
assert.match(steps[0].args[0], /patch-wwebjs-status\.js$/);
assert.deepEqual(steps[0].args.slice(1), ['--best-effort']);
});
test('planSteps: ready-sync patcher plans its own best-effort repair', () => {
const steps = planSteps(makeRoot({ readySyncPatcher: true }));
assert.equal(steps.length, 1);
assert.equal(steps[0].command, process.execPath);
assert.match(steps[0].args[0], /patch-wwebjs-ready-sync\.js$/);
assert.deepEqual(steps[0].args.slice(1), ['--best-effort']);
});
test('planSteps: participant-arity patcher plans its own best-effort repair', () => {
const steps = planSteps(makeRoot({ participantArityPatcher: true }));
assert.equal(steps.length, 1);
assert.equal(steps[0].command, process.execPath);
assert.match(steps[0].args[0], /patch-wwebjs-participant-arity\.js$/);
assert.deepEqual(steps[0].args.slice(1), ['--best-effort']);
});
test('planSteps: dashboard and all patchers run in stable order', () => {
// The fixture is derived rather than hand-listed. A hand-listed one never creates the file for a
// patcher added later, so planSteps never plans it, the count assertion stays green, and the test
// quietly stops covering what it is named for. The block and group-description patchers both
// reached that state.
assert.deepEqual(
[...EXPECTED_PATCHER_ORDER].sort(),
PATCHERS_ON_DISK,
'a patcher was added or removed: update EXPECTED_PATCHER_ORDER at the position planSteps runs it',
);
const steps = planSteps(makeRoot({ dashboard: true, patchers: PATCHERS_ON_DISK }));
assert.equal(steps.length, EXPECTED_PATCHER_ORDER.length + 1);
assert.equal(steps[0].command, 'npm ci');
assert.deepEqual(
steps.slice(1).map(step => path.basename(step.args[0])),
EXPECTED_PATCHER_ORDER,
);
for (const step of steps.slice(1)) {
assert.equal(step.command, process.execPath);
assert.deepEqual(
step.args.slice(1),
path.basename(step.args[0]) === 'patch-wwebjs-puppeteer.js' ? [] : ['--best-effort'],
);
}
});
test('run: nothing to do exits 0 and never spawns', () => {
const { calls, spawn } = fakeSpawn([OK]);
assert.equal(run(makeRoot(), spawn), 0);
assert.equal(calls.length, 0);
});
test('run: all steps succeed exits 0', () => {
const { calls, spawn } = fakeSpawn([OK, OK]);
assert.equal(run(makeRoot({ dashboard: true, patcher: true }), spawn), 0);
assert.equal(calls.length, 2);
});
test('run: non-zero dashboard install exits 1 and never reaches the patcher (fail-fast)', () => {
const { calls, spawn } = fakeSpawn([{ status: 1, signal: null, error: null }]);
assert.equal(run(makeRoot({ dashboard: true, patcher: true }), spawn), 1);
assert.equal(calls.length, 1);
assert.equal(calls[0].command, 'npm ci');
});
test('run: spawn error (npm not found) exits 1', () => {
const { spawn } = fakeSpawn([{ status: null, signal: null, error: new Error('spawn npm ENOENT') }]);
assert.equal(run(makeRoot({ dashboard: true }), spawn), 1);
});
test('run: step killed by a signal exits 1', () => {
const { spawn } = fakeSpawn([{ status: null, signal: 'SIGTERM', error: null }]);
assert.equal(run(makeRoot({ dashboard: true }), spawn), 1);
});
test('run: non-zero patcher exit propagates (half-patched tree must stay fatal)', () => {
const { calls, spawn } = fakeSpawn([{ status: 1, signal: null, error: null }]);
assert.equal(run(makeRoot({ patcher: true }), spawn), 1);
assert.equal(calls.length, 1);
});
test('failureReason: maps each spawnSync outcome to a cause (null = success)', () => {
assert.equal(failureReason(OK), null);
assert.equal(failureReason({ status: 2, signal: null, error: null }), 'exit code 2');
assert.equal(failureReason({ status: null, signal: 'SIGKILL', error: null }), 'killed by SIGKILL');
assert.match(failureReason({ status: null, signal: null, error: new Error('boom') }), /failed to start — boom/);
});
test('sanitizeEnv: strips allow-scripts environment variables across case and separator variations', () => {
const input = {
PATH: '/usr/bin',
npm_config_allow_scripts: 'true',
NPM_CONFIG_ALLOW_SCRIPTS: 'true',
'npm_config_allow-scripts': 'true',
'NPM_CONFIG_ALLOW-SCRIPTS': 'true',
npm_config_allow_scripts_extra: 'keep',
};
const result = sanitizeEnv(input);
assert.deepEqual(result, {
PATH: '/usr/bin',
npm_config_allow_scripts_extra: 'keep',
});
assert.equal(input.npm_config_allow_scripts, 'true');
});
test('planSteps: strips npm_config_allow_scripts from step options.env to avoid EALLOWSCRIPTS in npm 11', () => {
const env = {
PATH: '/usr/bin',
npm_config_allow_scripts: 'true',
NPM_CONFIG_ALLOW_SCRIPTS: 'true',
};
const steps = planSteps(
makeRoot({
dashboard: true,
patcher: true,
previewPatcher: true,
statusPatcher: true,
readySyncPatcher: true,
baileysPatcher: true,
}),
env,
);
assert.equal(steps.length, 6);
for (const step of steps) {
assert.equal('npm_config_allow_scripts' in step.options.env, false);
assert.equal('NPM_CONFIG_ALLOW_SCRIPTS' in step.options.env, false);
assert.equal(step.options.env.PATH, '/usr/bin');
}
});
test('run: passes sanitized environment to spawn calls', () => {
const { calls, spawn } = fakeSpawn([OK]);
const env = { PATH: '/usr/bin', npm_config_allow_scripts: 'true' };
run(makeRoot({ dashboard: true }), spawn, env);
assert.equal(calls.length, 1);
assert.equal('npm_config_allow_scripts' in calls[0].options.env, false);
assert.equal(calls[0].options.env.PATH, '/usr/bin');
});