File size: 23,960 Bytes
6d92394 6a6a742 6d92394 4d86073 6d92394 4d86073 6a6a742 4d86073 6a6a742 6d92394 c47fc37 6d92394 6a6a742 6d92394 6a6a742 6d92394 6a6a742 6d92394 6a6a742 6d92394 6a6a742 6d92394 6a6a742 6d92394 6a6a742 6d92394 6a6a742 6d92394 6a6a742 6d92394 4d86073 6d92394 6a6a742 6565340 6e309cb 6565340 6d92394 6a6a742 | 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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | import express from 'express';
import { spawn, execSync } from 'child_process';
import crypto from 'crypto';
import fs from 'fs';
import os from 'os';
import path from 'path';
import { fileURLToPath } from 'url';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const app = express();
const PORT = process.env.PORT || 7860;
const SECRET_KEY = process.env.SECRET_KEY;
if (!SECRET_KEY) {
console.error('[ERROR] SECRET_KEY environment variable is not set. Exiting.');
process.exit(1);
}
app.use(express.json());
app.use(express.static(path.join(__dirname, 'public')));
// ββ Session store βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const sessions = new Set();
// ββ ANSI stripper βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function stripAnsi(str) {
// eslint-disable-next-line no-control-regex
return str.replace(/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><~]/g, '');
}
// ββ Pre-seed shellular config from env vars βββββββββββββββββββββββββββββββββββ
function seedShellularConfig() {
const hostId = process.env.SHELLULAR_HOST_ID;
const keyB64 = process.env.SHELLULAR_KEY;
const machineId = process.env.SHELLULAR_MACHINE_ID;
if (!hostId || !keyB64 || !machineId) return;
const shellularDir = path.join(os.homedir(), '.shellular');
const configFile = path.join(shellularDir, 'config.json');
const keyFile = path.join(shellularDir, `shellular-${machineId}.e2ee`);
try {
fs.mkdirSync(shellularDir, { recursive: true });
if (!fs.existsSync(configFile)) {
fs.writeFileSync(configFile, JSON.stringify({ hostId, machineId }), 'utf-8');
console.log(`[shellular] seeded config: hostId=${hostId}`);
}
if (!fs.existsSync(keyFile)) {
fs.writeFileSync(keyFile, Buffer.from(keyB64, 'base64'), { mode: 0o600 });
console.log(`[shellular] seeded key: ${keyFile}`);
}
} catch (err) {
console.error('[shellular] failed to seed config:', err.message);
}
}
seedShellularConfig();
// ββ Shellular fetch patch βββββββββββββββββββββββββββββββββββββββββββββββββββββ
// WHY THIS EXISTS:
// The shellular registration API returns `success` as a non-boolean (e.g. the
// string "true" or "success") but shellular's Zod schema uses a discriminated
// union that only accepts the strict booleans true | false β so validation
// crashes with "invalid_union" before the QR is ever generated.
//
// WHY globalThis.fetch PATCHING DOESN'T WORK:
// Shellular imports undici directly (e.g. `import { fetch } from 'undici'`)
// rather than using globalThis.fetch, so patching the global has no effect.
//
// THE FIX β patch at the undici global dispatcher level:
// Every HTTP call undici makes β regardless of which API (fetch, request,
// stream, pipeline) β goes through the global dispatcher. By replacing it
// we intercept the raw response bytes before Zod ever sees them and coerce
// the `success` field to a proper boolean.
// Write the patch file INSIDE shellular's installation directory so that
// `import 'undici'` resolves correctly via Node's ESM node_modules lookup.
// Writing to /tmp/ fails because there is no node_modules there.
function findShellularRoot() {
try {
const globalRoot = execSync('npm root -g', { encoding: 'utf-8' }).trim();
const p = path.join(globalRoot, 'shellular');
if (fs.existsSync(p)) return p;
} catch {}
// Fallback to the path set in the Dockerfile
return '/home/node/.npm-global/lib/node_modules/shellular';
}
const PATCH_FILE = path.join(findShellularRoot(), 'fetch-patch.mjs');
function writeFetchPatch() {
const code = `
import { getGlobalDispatcher, setGlobalDispatcher } from 'undici';
const _orig = getGlobalDispatcher();
// ββ Handler wrapper β buffers JSON responses and patches the success field βββ
class SuccessPatchingHandler {
constructor(inner) {
this.inner = inner;
this.isJson = false;
this.chunks = [];
}
onConnect(abort) { return this.inner.onConnect(abort); }
onError(err) { return this.inner.onError(err); }
onUpgrade(...a) { return this.inner.onUpgrade?.(...a); }
onBodySent(chunk) { return this.inner.onBodySent?.(chunk); }
onHeaders(statusCode, headers, resume, statusMessage) {
// headers is a flat Buffer array: [name, value, name, value β¦]
for (let i = 0; i < headers.length; i += 2) {
if (
headers[i].toString().toLowerCase() === 'content-type' &&
headers[i + 1].toString().includes('application/json')
) {
this.isJson = true;
}
}
return this.inner.onHeaders(statusCode, headers, resume, statusMessage);
}
onData(chunk) {
if (this.isJson) {
this.chunks.push(chunk);
return true; // signal undici to keep reading
}
return this.inner.onData(chunk);
}
onComplete(trailers) {
if (this.isJson && this.chunks.length) {
const raw = Buffer.concat(this.chunks).toString('utf-8');
try {
const json = JSON.parse(raw);
if ('success' in json && typeof json.success !== 'boolean') {
const s = json.success;
const before = s;
// Coerce: anything truthy except the strings "0" / "false" β true
json.success = (
s === true || s === 1 ||
(typeof s === 'string' && s.length > 0 && s !== '0' && s !== 'false')
);
console.log('[patch] coerced success field:', JSON.stringify(before), 'β', json.success);
this.inner.onData(Buffer.from(JSON.stringify(json)));
} else {
// Nothing to patch β pass through as-is
this.inner.onData(Buffer.concat(this.chunks));
}
} catch (e) {
// Not valid JSON β pass through unchanged
this.inner.onData(Buffer.concat(this.chunks));
}
}
return this.inner.onComplete(trailers);
}
}
// ββ Dispatcher wrapper β routes every request through the patching handler βββ
class SuccessPatchingDispatcher {
dispatch(opts, handler) {
return _orig.dispatch(opts, new SuccessPatchingHandler(handler));
}
close() { return _orig.close?.(); }
destroy(err, cb) { return _orig.destroy?.(err, cb); }
}
setGlobalDispatcher(new SuccessPatchingDispatcher());
console.log('[patch] undici dispatcher patched β success field will be coerced to boolean');
`;
fs.writeFileSync(PATCH_FILE, code, 'utf-8');
console.log('[patch] undici dispatcher patch written to', PATCH_FILE);
}
writeFetchPatch();
// ββ Auth routes βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
app.post('/api/login', (req, res) => {
const { key } = req.body;
if (!key || key !== SECRET_KEY) {
return res.status(401).json({ error: 'Invalid key' });
}
const token = crypto.randomUUID();
sessions.add(token);
res.json({ token });
});
app.post('/api/logout', (req, res) => {
const token = req.headers.authorization?.split(' ')[1];
sessions.delete(token);
res.json({ ok: true });
});
// ββ Auth middleware ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function requireAuth(req, res, next) {
const token = req.headers.authorization?.split(' ')[1];
if (!token || !sessions.has(token)) {
return res.status(401).json({ error: 'Unauthorized' });
}
next();
}
// ββ Shellular process management ββββββββββββββββββββββββββββββββββββββββββββββ
let shellularProc = null;
let outputBuffer = '';
const sseClients = new Set();
function send(res, payload) {
res.write(`data: ${JSON.stringify(payload)}\n\n`);
}
function broadcast(payload) {
const frame = `data: ${JSON.stringify(payload)}\n\n`;
for (const client of sseClients) {
client.write(frame);
}
}
let retryTimer = null;
function startShellular() {
if (shellularProc || retryTimer) return;
broadcast({ type: 'status', status: 'starting' });
shellularProc = spawn('shellular', ['--unknown-clients', 'always-allow'], {
env: {
...process.env,
FORCE_COLOR: '0',
// Preload the undici dispatcher patch BEFORE shellular initialises.
// --import runs the ESM module first, so the patched dispatcher is in
// place before any of shellular's own imports execute.
NODE_OPTIONS: `--import file://${PATCH_FILE}`,
},
stdio: ['ignore', 'pipe', 'pipe'],
});
let procOutput = '';
const handleData = (chunk) => {
const text = stripAnsi(chunk.toString());
procOutput += text;
outputBuffer += text;
broadcast({ type: 'output', text });
};
shellularProc.stdout.on('data', handleData);
shellularProc.stderr.on('data', handleData);
shellularProc.on('error', (err) => {
// ββ DIAGNOSTIC ERROR TYPE: spawn-error ββββββββββββββββββββββββββββββββββ
// Means the shellular binary could not be found or could not be executed.
// Most likely cause: npm install -g shellular failed in the Dockerfile,
// or PATH is missing /home/node/.npm-global/bin.
// To debug: run `which shellular` and `shellular --version` in the container.
const text = [
'',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'β DIAGNOSTIC: spawn-error β',
'β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£',
`β Cannot start the shellular binary: ${err.message}`,
'β Likely cause: shellular not installed or PATH wrong. β',
'β Fix: rebuild the Space (Dockerfile installs shellular). β',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'',
].join('\n');
outputBuffer += text;
broadcast({ type: 'output', text });
shellularProc = null;
broadcast({ type: 'status', status: 'error' });
});
shellularProc.on('exit', (code, signal) => {
shellularProc = null;
// ββ Classify the exit reason for clear diagnostics ββββββββββββββββββββ
const isSchemaError = code === 1 && !signal &&
procOutput.includes('invalid_union');
const isPatchBypassed = code === 1 && !signal &&
procOutput.includes('invalid_union') &&
!procOutput.includes('[patch] coerced success field');
// ^ If you see invalid_union BUT "[patch] coerced" never printed, the
// undici patch did not load. Check NODE_OPTIONS in the spawn call above.
const isRateLimit = code === 1 && !signal && !isSchemaError &&
(procOutput.includes('Too many requests') || procOutput.includes('rate'));
const isAuthError = code === 1 && !signal &&
(procOutput.includes('401') || procOutput.includes('Unauthorized') ||
procOutput.includes('authentication'));
const isNetworkError = code === 1 && !signal &&
(procOutput.includes('ECONNREFUSED') || procOutput.includes('ENOTFOUND') ||
procOutput.includes('ETIMEDOUT') || procOutput.includes('fetch failed'));
if (isSchemaError) {
// ββ DIAGNOSTIC ERROR TYPE: schema-mismatch βββββββββββββββββββββββββββ
// The shellular registration API returned a response whose shape does
// not match shellular's Zod schema.
//
// If "[patch] coerced success field" DID print above this message,
// the undici patch ran but the API changed in a different field β look
// at the raw error above to see which field/path Zod rejected.
//
// If "[patch] coerced success field" did NOT print, the patch never
// ran β NODE_OPTIONS may have been stripped or the patch file missing.
const patchRan = procOutput.includes('[patch] coerced success field');
const msg = [
'',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'β DIAGNOSTIC: schema-mismatch (invalid_union) β',
'β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£',
`β Undici patch loaded: ${patchRan ? 'YES β
' : 'NO β β patch never ran!'}`,
'β',
patchRan
? 'β The API changed a DIFFERENT field than "success".'
: 'β NODE_OPTIONS may have been stripped. Check spawn env.',
'β',
'β What to do:',
'β 1. Copy the full output above and share it.',
'β 2. Look for the "path" field in the [error] JSON β',
'β it tells you exactly which field Zod rejected.',
'β 3. Rebuild the Space to pull shellular@latest.',
'β 4. Workaround: set SHELLULAR_HOST_ID + SHELLULAR_KEY +',
'β SHELLULAR_MACHINE_ID as HF Secrets (skips registration).',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
' Retrying in 5 minutesβ¦',
'',
].join('\n');
outputBuffer += msg;
broadcast({ type: 'output', text: msg });
broadcast({ type: 'status', status: 'retrying' });
retryTimer = setTimeout(() => {
retryTimer = null;
const m = '\n[Retrying after schema errorβ¦]\n';
outputBuffer += m;
broadcast({ type: 'output', text: m });
startShellular();
}, 5 * 60 * 1000);
} else if (isRateLimit) {
// ββ DIAGNOSTIC ERROR TYPE: rate-limited ββββββββββββββββββββββββββββββ
// api.shellular.dev rejected registration because this host or IP has
// registered too many times in a short window.
// Fix: save the SHELLULAR_* secrets so registration is skipped entirely.
const WAIT = 30;
const msg = [
'',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'β DIAGNOSTIC: rate-limited β',
'β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£',
'β api.shellular.dev refused registration (too many calls). β',
'β Fix: save SHELLULAR_HOST_ID + SHELLULAR_KEY + β',
'β SHELLULAR_MACHINE_ID as HF Secrets. β',
`β Retrying in ${WAIT}sβ¦ β`,
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'',
].join('\n');
outputBuffer += msg;
broadcast({ type: 'output', text: msg });
broadcast({ type: 'status', status: 'retrying' });
retryTimer = setTimeout(() => {
retryTimer = null;
const m = '\n[Retrying registrationβ¦]\n';
outputBuffer += m;
broadcast({ type: 'output', text: m });
startShellular();
}, WAIT * 1000);
} else if (isNetworkError) {
// ββ DIAGNOSTIC ERROR TYPE: network-error βββββββββββββββββββββββββββββ
// shellular could not reach api.shellular.dev at all.
// Could be a HF Space outbound network restriction or a DNS issue.
const msg = [
'',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'β DIAGNOSTIC: network-error β',
'β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£',
'β shellular could not reach api.shellular.dev. β',
'β Possible causes: β',
'β - Outbound network blocked in this HF Space tier. β',
'β - api.shellular.dev is down. β',
'β - DNS resolution failing inside the container. β',
'β Retrying in 30sβ¦ β',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'',
].join('\n');
outputBuffer += msg;
broadcast({ type: 'output', text: msg });
broadcast({ type: 'status', status: 'retrying' });
retryTimer = setTimeout(() => {
retryTimer = null;
startShellular();
}, 30 * 1000);
} else if (isAuthError) {
// ββ DIAGNOSTIC ERROR TYPE: auth-error ββββββββββββββββββββββββββββββββ
// The SHELLULAR_* secrets saved in HF are invalid or expired.
// The host identity on api.shellular.dev may have been reset.
// Fix: delete the three SHELLULAR_* secrets from HF, restart the Space
// to re-register fresh, then save the new values from the setup panel.
const msg = [
'',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'β DIAGNOSTIC: auth-error β',
'β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£',
'β Saved SHELLULAR_* secrets were rejected by the API. β',
'β Fix: delete SHELLULAR_HOST_ID + SHELLULAR_KEY + β',
'β SHELLULAR_MACHINE_ID from HF Secrets, then restart β',
'β to re-register and get fresh values. β',
'ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ',
'',
].join('\n');
outputBuffer += msg;
broadcast({ type: 'output', text: msg });
broadcast({ type: 'status', status: 'error' });
} else {
// ββ DIAGNOSTIC ERROR TYPE: unknown-exit ββββββββββββββββββββββββββββββ
// shellular exited for an unrecognised reason.
// Share the full output above (especially any [error] JSON lines)
// to diagnose further.
const text = code !== 0
? `\n[shellular exited β code=${code ?? '?'}, signal=${signal ?? 'none'}]\n`
: '\n[shellular disconnected]\n';
outputBuffer += text;
broadcast({ type: 'output', text });
broadcast({ type: 'status', status: 'stopped' });
}
});
broadcast({ type: 'status', status: 'running' });
}
function stopShellular() {
if (retryTimer) { clearTimeout(retryTimer); retryTimer = null; }
if (!shellularProc) return;
shellularProc.kill('SIGTERM');
shellularProc = null;
}
// ββ SSE stream βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
app.get('/api/stream', requireAuth, (req, res) => {
res.setHeader('Content-Type', 'text/event-stream');
res.setHeader('Cache-Control', 'no-cache');
res.setHeader('Connection', 'keep-alive');
res.setHeader('X-Accel-Buffering', 'no');
res.flushHeaders();
send(res, { type: 'status', status: shellularProc ? 'running' : 'stopped' });
if (outputBuffer) {
send(res, { type: 'output', text: outputBuffer });
}
sseClients.add(res);
req.on('close', () => sseClients.delete(res));
});
// ββ Control endpoints ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
app.post('/api/shellular/start', requireAuth, (_req, res) => {
startShellular();
res.json({ ok: true, running: !!shellularProc });
});
app.post('/api/shellular/stop', requireAuth, (_req, res) => {
stopShellular();
outputBuffer = '';
broadcast({ type: 'output', text: '' });
res.json({ ok: true });
});
app.post('/api/shellular/restart', requireAuth, (_req, res) => {
stopShellular();
outputBuffer = '';
broadcast({ type: 'clear' });
setTimeout(startShellular, 600);
res.json({ ok: true });
});
app.get('/api/status', requireAuth, (_req, res) => {
res.json({ running: !!shellularProc });
});
app.get('/api/setup-status', requireAuth, (_req, res) => {
const seeded = !!(
process.env.SHELLULAR_HOST_ID &&
process.env.SHELLULAR_KEY &&
process.env.SHELLULAR_MACHINE_ID
);
res.json({ seeded });
});
app.get('/api/shellular/credentials', requireAuth, (_req, res) => {
try {
const shellularDir = path.join(os.homedir(), '.shellular');
const configRaw = fs.readFileSync(path.join(shellularDir, 'config.json'), 'utf-8');
const { hostId, machineId } = JSON.parse(configRaw);
const keyFile = path.join(shellularDir, `shellular-${machineId}.e2ee`);
const keyB64 = fs.readFileSync(keyFile).toString('base64');
res.json({ hostId, machineId, keyB64 });
} catch {
res.status(404).json({ error: 'Not registered yet.' });
}
});
app.get('/api/shellular/qr-data', requireAuth, (_req, res) => {
try {
const shellularDir = path.join(os.homedir(), '.shellular');
const configRaw = fs.readFileSync(path.join(shellularDir, 'config.json'), 'utf-8');
const { hostId, machineId } = JSON.parse(configRaw);
const keyFile = path.join(shellularDir, `shellular-${machineId}.e2ee`);
const keyB64 = fs.readFileSync(keyFile).toString('base64');
res.json({ qrData: `${hostId}:${keyB64}` });
} catch {
res.status(404).json({ error: 'Config not seeded yet.' });
}
});
// ββ Start ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
app.listen(PORT, '0.0.0.0', () => {
console.log(`Shellular Web UI β http://0.0.0.0:${PORT}`);
}); |