@jacebenson/jsn 4.3.7-dev.35 → 4.3.7-dev.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jacebenson/jsn",
-  "version": "4.3.7-dev.35",
+  "version": "4.3.7-dev.37",
   "description": "A command-line interface for ServiceNow that follows the Unix philosophy: simple, composable, and scriptable.",
   "type": "module",
   "bin": {

package/src/commands/midservers.js

@@ -1,12 +1,13 @@
 import fs from 'node:fs';
 import path from 'node:path';
+import process from 'node:process';
 import { input, password as passwordPrompt, select } from '@inquirer/prompts';
 import { confirmDelete, formatRecordForDisplay, getStringField, interactiveList, canPrompt, assertSafeExactMatch } from '../helpers.js';
 import { FormatAuto } from '../output.js';
 import { declareCapabilities } from '../capabilities.js';
 import { resolveRecord, unwrapSysId } from '../resolve-record.js';
 import { detectDocker, defaultRun, installDockerMidServer, midInstallDirectory, normalizeMidName, validateMidCredentials } from '../midserver-install.js';
-import { detectDirectPlatform, installDirectMidServer, readDirectInstallation, removeDirectInstallation, runDirectInstallation } from '../midserver-direct.js';
+import { detectDirectPlatform, followDirectLog, installDirectMidServer, readDirectInstallation, removeDirectInstallation, resolveDirectLogFile, runDirectInstallation } from '../midserver-direct.js';
 
 const AGENT_TABLE = 'ecc_agent';
 const QUEUE_TABLE = 'ecc_queue';
@@ -171,6 +172,40 @@ function midDiagnosticsCommand(kind, wrap) {
   };
 }
 
+// Progress for long, otherwise-silent direct-install phases. Human terminals
+// only, and on stderr, so the stdout envelope and --json output stay clean.
+export function directProgress(app) {
+  const human = app.output?.getFormat() === FormatAuto && (canPrompt() || process.stderr.isTTY === true);
+  if (!human) return () => {};
+  const mib = bytes => (Number(bytes || 0) / (1024 * 1024)).toFixed(0);
+  return event => {
+    if (event.phase === 'download-start') {
+      process.stderr.write(`Downloading the official MID ZIP from ServiceNow (about 532 MiB).\n  ${event.archiveURL}\n`);
+    } else if (event.phase === 'download') {
+      const percent = event.total ? ` (${Math.floor((event.received / event.total) * 100)}%)` : '';
+      process.stderr.write(`\r  ${mib(event.received)} MiB${percent} downloaded...`);
+      if (event.done) process.stderr.write('\n');
+    } else if (event.phase === 'extract-start') {
+      process.stderr.write(`Extracting ${event.entries} files into ${event.installDir}...\n`);
+    } else if (event.phase === 'extract-done') {
+      process.stderr.write('Extraction complete. Configuring the MID Server...\n');
+    }
+  };
+}
+
+// A registration wait is minutes of silence otherwise; report elapsed progress.
+export function registrationProgress(app, timeoutMs) {
+  const human = app.output?.getFormat() === FormatAuto && (canPrompt() || process.stderr.isTTY === true);
+  if (!human) return undefined;
+  const seconds = Math.round(timeoutMs / 1000);
+  let lastReport = 0;
+  return elapsedMs => {
+    if (elapsedMs - lastReport < 15000) return;
+    lastReport = elapsedMs;
+    process.stderr.write(`Waiting for ServiceNow to register the MID Server... ${Math.round(elapsedMs / 1000)}s of ${seconds}s\n`);
+  };
+}
+
 async function listAgents(app, argv) {
   const columns = argv.columns
     ? [...new Set(argv.columns.split(',').map(column => column.trim()).filter(Boolean))]
@@ -266,10 +301,11 @@ async function promptMidCredentials(app, argv) {
   }
 }
 
-export async function waitForMidServerUp(app, name, timeoutMs, intervalMs) {
+export async function waitForMidServerUp(app, name, timeoutMs, intervalMs, onWait) {
   const started = Date.now();
   const fullName = name;
   while (Date.now() - started <= timeoutMs) {
+    onWait?.(Date.now() - started);
     const params = new URLSearchParams({
       sysparm_query: `name=${fullName}`,
       sysparm_limit: '1',
@@ -308,14 +344,13 @@ function removeLocalMidServer(instanceURL, name, directory) {
   return true;
 }
 
-function showMidServerLogs(app, identifier, argv) {
+async function showMidServerLogs(app, identifier, argv) {
   const installDir = argv.directory || midInstallDirectory(app.getEffectiveInstance(), identifier);
   const direct = readDirectInstallation(app.getEffectiveInstance(), identifier, argv.directory);
   if (direct) {
     if (!Number.isInteger(argv.tail) || argv.tail < 1 || argv.tail > 10000) throw new Error('Use --tail between 1 and 10000');
-    if (argv.follow) throw new Error('Direct log follow is not supported; read logs again or use the native host log viewer');
-    const logfile = path.join(installDir, 'agent', 'logs', 'agent0.log');
-    if (!fs.existsSync(logfile)) throw new Error('No MID agent log yet; the installation may only be prepared');
+    const logfile = resolveDirectLogFile(installDir);
+    if (!logfile) throw new Error('No MID agent log yet; the installation may only be prepared');
     const stat = fs.lstatSync(logfile);
     if (!stat.isFile() || stat.isSymbolicLink()) throw new Error('Untrusted MID log path');
     const fd = fs.openSync(logfile, 'r');
@@ -324,8 +359,15 @@ function showMidServerLogs(app, identifier, argv) {
       const length = Math.min(stat.size, 1024 * 1024);
       const buffer = Buffer.alloc(length);
       fs.readSync(fd, buffer, 0, length, stat.size - length);
-      text = buffer.toString('utf8').split('\n').slice(-argv.tail).join('\n');
+      const all = buffer.toString('utf8').split('\n');
+      if (all.length && all[all.length - 1] === '') all.pop();
+      text = all.slice(-argv.tail).join('\n');
     } finally { fs.closeSync(fd); }
+    if (argv.follow) {
+      // Following streams new lines directly; the JSON envelope would be unreachable.
+      process.stdout.write(`Tailing ${logfile} (Ctrl+C to stop)\n${text}\n`);
+      return followDirectLog(installDir);
+    }
     app.ok({ installation: 'direct', logfile, text, _formatted: `${text}\n` }, { summary: 'Local MID agent log (last 1 MiB maximum)' });
     return;
   }
@@ -377,10 +419,10 @@ export function midserversCmd(wrap) {
         describe: 'Show local native or Docker Compose MID logs',
         builder: (b) => b
           .option('tail', { type: 'number', default: 100, describe: 'Number of log lines' })
-          .option('follow', { type: 'boolean', default: false, describe: 'Follow the logs (Compose only)' })
+          .option('follow', { type: 'boolean', default: false, describe: 'Follow the logs' })
           .option('directory', { type: 'string', describe: 'Local installation directory override' }),
         handler: wrap(async (argv, app) => {
-          showMidServerLogs(app, argv.identifier, argv);
+          await showMidServerLogs(app, argv.identifier, argv);
         }),
       })
       .command({
@@ -388,10 +430,10 @@ export function midserversCmd(wrap) {
         describe: 'Show local native or Docker Compose MID logs',
         builder: (b) => b
           .option('tail', { type: 'number', default: 100, describe: 'Number of log lines' })
-          .option('follow', { type: 'boolean', default: false, describe: 'Follow the logs (Compose only)' })
+          .option('follow', { type: 'boolean', default: false, describe: 'Follow the logs' })
           .option('directory', { type: 'string', describe: 'Local installation directory override' }),
         handler: wrap(async (argv, app) => {
-          showMidServerLogs(app, argv.identifier, argv);
+          await showMidServerLogs(app, argv.identifier, argv);
         }),
       })
       .command({
@@ -472,15 +514,24 @@ export function midserversCmd(wrap) {
             const existing = await app.sdk.list(AGENT_TABLE, new URLSearchParams({ sysparm_query: `name=${shortName}`, sysparm_fields: 'sys_id,name', sysparm_limit: '1' }));
             if (existing.length) throw new Error(`MID '${shortName}' already exists in ServiceNow; choose a new name. Existing runtime and record were not changed.`);
             const installation = await installDirectMidServer({
-              instanceURL: app.getEffectiveInstance(), ...credentials, name, directory: argv.directory, runNow: decision === 'start',
+              instanceURL: app.getEffectiveInstance(), ...credentials, name, directory: argv.directory,
+              runNow: decision === 'start', onProgress: directProgress(app),
             });
             if (installation.state === 'prepared') {
               app.ok(installation, { summary: `Prepared native MID '${installation.name}' in ${installation.installDir}; not started or registered. Start with jsn midservers start ${installation.name}${argv.directory ? ' --directory ' + JSON.stringify(installation.installDir) : ''}. Windows start runs in the foreground console; no service is installed.` });
               return;
             }
             let record;
-            try { record = await waitForMidServerUp(app, installation.name, Math.max(1, argv['wait-timeout']), Math.max(500, argv['wait-interval'])); }
+            const directWait = Math.max(1, argv['wait-timeout']);
+            const directInterval = Math.max(500, argv['wait-interval']);
+            const onWait = registrationProgress(app, directWait);
+            const started = Date.now();
+            try {
+              record = await waitForMidServerUp(app, installation.name, directWait, directInterval, onWait);
+              onWait?.(directWait);
+            }
             catch {
+              onWait?.(Math.max(directWait, Date.now() - started));
               app.ok({ ...installation, registration: 'pending', validated: false }, { summary: `Native MID start command completed; registration is pending. Runtime retained for diagnostics at ${installation.installDir}; no forced teardown.` });
               return;
             }

package/src/midserver-direct.js

@@ -71,20 +71,28 @@ function checkParents(directory, platform) {
   }
 }
 
-export async function downloadMidZip(url, archive, fetchImpl = fetch) {
+export async function downloadMidZip(url, archive, fetchImpl = fetch, onProgress) {
   const response = await fetchImpl(url, { redirect: 'error', signal: AbortSignal.timeout(600000) });
   if (!response.ok || !response.body) throw new Error(`MID ZIP download failed (HTTP ${response.status})`);
   const length = Number(response.headers.get('content-length'));
   if (length > MAX_ARCHIVE) throw new Error('MID ZIP exceeds 1 GiB download limit');
+  onProgress?.({ phase: 'download', received: 0, total: Number.isFinite(length) ? length : 0 });
   const fd = fs.openSync(archive, 'wx', 0o600);
   let size = 0;
+  let reported = 0;
+  const step = Math.max(4 * 1024 * 1024, Math.floor((Number.isFinite(length) ? length : MAX_ARCHIVE) / 100));
   try {
     for await (const chunk of response.body) {
       size += chunk.length;
       if (size > MAX_ARCHIVE) throw new Error('MID ZIP exceeds 1 GiB download limit');
       fs.writeSync(fd, chunk);
+      if (onProgress && size - reported >= step) {
+        reported = size;
+        onProgress({ phase: 'download', received: size, total: Number.isFinite(length) ? length : 0 });
+      }
     }
     if (length && size !== length) throw new Error('Incomplete MID ZIP download');
+    onProgress?.({ phase: 'download', received: size, total: size, done: true });
   } finally { fs.closeSync(fd); }
 }
 
@@ -145,6 +153,55 @@ export function readDirectInstallation(instanceURL, name, directory) {
   return metadata;
 }
 
+// The vendor rotates agent0.log to agent0.log.0 (and upward), so the plain
+// name may not exist on a healthy install. Newest real file wins; links and
+// non-files are never followed.
+export function resolveDirectLogFile(installDir) {
+  const directory = path.join(installDir, 'agent', 'logs');
+  let names;
+  try { names = fs.readdirSync(directory); } catch (error) { if (error.code === 'ENOENT') return null; throw error; }
+  const candidates = [];
+  for (const name of names) {
+    const agent = /^agent0\.log(\.\d+)?$/.test(name);
+    if (!agent && name !== 'wrapper.log') continue;
+    const full = path.join(directory, name);
+    const stat = fs.lstatSync(full);
+    if (!stat.isFile() || stat.isSymbolicLink()) continue;
+    candidates.push({ full, agent, mtime: stat.mtimeMs });
+  }
+  candidates.sort((a, b) => (b.agent - a.agent) || (b.mtime - a.mtime));
+  return candidates.length ? candidates[0].full : null;
+}
+
+/**
+ * Tail a direct install's agent log, following rotation.
+ *
+ * The vendor rotates by creating a new file, so the followed path can change
+ * between polls; a shrinking file is treated as truncation and re-read from
+ * the start. Each appended chunk is handed to `writer` unchanged.
+ */
+export async function followDirectLog(installDir, { writer = chunk => process.stdout.write(chunk), intervalMs = 1000, iterations = Infinity, sleep } = {}) {
+  const pause = sleep || (ms => new Promise(resolve => setTimeout(resolve, ms)));
+  let file = resolveDirectLogFile(installDir);
+  if (!file) throw new Error('No MID agent log yet; the installation may only be prepared');
+  let offset = fs.statSync(file).size;
+  for (let seen = 0; seen < iterations; seen++) {
+    await pause(intervalMs);
+    const next = resolveDirectLogFile(installDir) || file;
+    if (next !== file) { file = next; offset = 0; }
+    const stat = fs.lstatSync(file);
+    if (!stat.isFile() || stat.isSymbolicLink()) return;
+    if (stat.size < offset) offset = 0;
+    if (stat.size === offset) continue;
+    const length = stat.size - offset;
+    const buffer = Buffer.alloc(length);
+    const fd = fs.openSync(file, 'r');
+    try { fs.readSync(fd, buffer, 0, length, offset); } finally { fs.closeSync(fd); }
+    offset = stat.size;
+    writer(buffer.toString('utf8'));
+  }
+}
+
 function uncertainState(metadata) {
   return `MID '${metadata.name}' runtime state is uncertain after an interrupted lifecycle command. Confirm no vendor MID process from ${metadata.installDir} is running, then rerun; installed files are kept.`;
 }
@@ -189,7 +246,7 @@ export function removeDirectInstallation(metadata, run = defaultRun) {
 }
 
 export async function installDirectMidServer({ instanceURL, username, password, name, directory, releaseName: suppliedRelease,
-  runNow = false, platform = process.platform, arch = process.arch, fetchImpl = fetch, download = downloadMidZip,
+  runNow = false, platform = process.platform, arch = process.arch, fetchImpl = fetch, download = downloadMidZip, onProgress,
   protect = protectDirectory, run = defaultRun }) {
   const native = detectDirectPlatform(platform, arch);
   if (native === 'linux' && process.getuid?.() === 0) throw new Error('Run direct MID installation as a non-root user');
@@ -216,9 +273,12 @@ export async function installDirectMidServer({ instanceURL, username, password,
   let prepared = false;
   try {
     protect(installDir, native);
-    await download(archiveURL, archive, fetchImpl);
+    onProgress?.({ phase: 'download-start', archiveURL, platform: native, installDir, name: shortName });
+    await download(archiveURL, archive, fetchImpl, onProgress);
     const entries = inspectMidZip(archive);
+    onProgress?.({ phase: 'extract-start', entries: entries.length, installDir });
     await extractMidZip(archive, installDir, entries);
+    onProgress?.({ phase: 'extract-done', entries: entries.length, installDir });
     const agent = path.join(installDir, 'agent');
     for (const filename of ['config.xml', 'conf/wrapper-override.conf', native === 'linux' ? 'bin/mid.sh' : 'bin/mid.bat']) {
       if (!fs.statSync(path.join(agent, filename)).isFile()) throw new Error(`Vendor ZIP missing ${filename}`);