reslop 0.2.4 → 0.2.6

package/lib/session/npm.js

@@ -1,94 +1,47 @@
 'use strict';
 
+const metautil = require('metautil');
+const { bytesToSize } = metautil;
 const commands = require('../npm-commands.js');
 const npm = require('../render/npm.js');
-const { logViewRows } = npm;
+const { logViewRows, expandLogLines } = npm;
+const ansi = require('../ansi.js');
+const { stripAnsi } = ansi;
+const reportParse = require('../report-parse.js');
+const { buildDocument } = reportParse;
+const reportRender = require('../report-render.js');
+const { renderDocument, loggedText } = reportRender;
+const reportView = require('../render/report.js');
+const { renderReport } = reportView;
 
-const { listCommands, reduceOutput, writeLog, parseScriptLine } = commands;
-const { staleLogFiles, removeStaleLogs, formatSize } = commands;
-const { scriptLine, saveScript, removeScript, reorderScript } = commands;
-const { startNpm } = commands;
+const { listCommands, reduceOutput, nextLogFile, saveLogs } = commands;
+const { staleLogFiles, removeStaleLogs, startNpm } = commands;
+const { saveScript, removeScript, reorderScript } = commands;
 
-const selected = (api) => {
-  const cursor = api.ui.nav.npmCursor;
-  return api.state.commands[cursor];
-};
-
-const clampCursor = (api) => {
-  const last = api.state.commands.length - 1;
-  const nav = api.ui.nav;
-  if (nav.npmCursor > last) nav.npmCursor = Math.max(0, last);
-  if (nav.npmCursor < 0) nav.npmCursor = 0;
-};
+const NAME_RE = /^[\w:.-]+$/;
+const TESTS_RE = /^(?:TAP version \d+|\s*(?:not )?ok\b|[ℹi]\s+tests\s+\d+)/m;
 
-const refresh = (api) => {
-  api.state.commands = listCommands(api.ui.top);
-  clampCursor(api);
+const logRowCount = (text, width, running) => {
+  const visual = width > 0 ? expandLogLines(text, width).length : 0;
+  const extra = running ? 1 : 0;
+  if (visual) return visual + extra;
+  const lines = `${text ?? ''}`.split('\n');
+  const count = lines.at(-1) === '' ? lines.length - 1 : lines.length;
+  return count + extra;
 };
 
-const canEdit = (ui) => {
-  if (ui.capabilities && ui.capabilities.changes === false) return false;
-  if (ui.readOnly) return false;
-  return true;
-};
-
-const refreshLogs = (api) => {
-  try {
-    const found = staleLogFiles(api.ui.top);
-    api.state.logBytes = found.bytes;
-  } catch (error) {
-    api.state.logBytes = 0;
-    api.ui.status = error.message;
+const filteredOutput = (raw, root, status, rawFile) => {
+  const text = stripAnsi(`${raw ?? ''}`);
+  if (status === '' || !TESTS_RE.test(text)) {
+    const output = reduceOutput(raw, root, status);
+    return { output, log: output };
   }
+  const doc = buildDocument(raw, '', root, status, 'test');
+  return { output: renderReport(doc), log: renderDocument(doc, rawFile) };
 };
 
-const open = (api) => {
-  if (api.ui.mode === 'compose') return;
-  refresh(api);
-  refreshLogs(api);
-  api.state.viewing = false;
-  api.state.output = '';
-  api.ui.nav.pane = 'npm';
-  api.ui.status = '';
-  api.ui.nav.clearSelection();
-};
-
-const scrollLog = (api, delta) => {
-  const lines = api.state.output.split('\n');
-  let count = lines.at(-1) === '' ? lines.length - 1 : lines.length;
-  if (api.state.running) count += 1;
-  const frame = api.ui.lastFrame;
-  const bodyH = frame && frame.bodyH ? frame.bodyH : 1;
-  const max = Math.max(0, count - logViewRows(bodyH));
-  let start = api.state.followEnd ? max : api.state.logScroll;
-  start = Math.min(max, Math.max(0, start + delta));
-  api.state.followEnd = start === max;
-  api.state.logScroll = start;
-};
-
-const move = (api, delta) => {
-  if (api.state.viewing) return void scrollLog(api, delta);
-  if (!api.state.commands.length) return;
-  const nav = api.ui.nav;
-  const last = api.state.commands.length - 1;
-  const next = Math.min(last, Math.max(0, nav.npmCursor + delta));
-  if (next === nav.npmCursor) return;
-  nav.npmCursor = next;
-  api.ui.status = '';
-};
-
-const stopRun = (api) => {
-  api.state.running = false;
-  api.state.child = null;
-  if (api.ui.progress) api.ui.progress.stop('npm');
-};
-
-const showOutput = (api, text) => {
-  if (!api.state.viewing || !api.state.running) return;
-  if (api.state.stopping) return;
-  api.state.output = text;
-  api.ui.paint();
-};
+const runLabel = (entry) =>
+  entry.kind === 'bin' ? `npm exec ${entry.name}` : `npm run ${entry.name}`;
 
 const withNotice = (text, notice) => {
   const body = `${text ?? ''}`;
@@ -98,291 +51,402 @@ const withNotice = (text, notice) => {
   return `${body}\n${notice}\n`;
 };
 
-const finishRun = (api, entry, result) => {
-  const stopped = api.state.stopping === true;
-  const reduced = stopped
-    ? withNotice(api.state.output, 'terminated')
-    : reduceOutput(result.text, api.ui.top, result.status);
-  api.state.output = reduced;
-  api.state.stopping = false;
-  stopRun(api);
-  try {
-    writeLog(api.ui.top, entry.name, reduced);
-  } catch (error) {
-    api.ui.status = error.message;
-    api.ui.paint();
-    return;
-  }
-  if (stopped && api.state.viewing) api.ui.status = 'terminated';
-  api.ui.paint();
+const withNewline = (text) => {
+  const body = `${text ?? ''}`;
+  if (!body || body.endsWith('\n')) return body;
+  return `${body}\n`;
 };
 
-const startRun = (api, entry) => {
-  api.state.output = '';
-  api.state.viewing = true;
-  api.state.followEnd = true;
-  api.state.logScroll = 0;
-  api.state.running = true;
-  api.state.stopping = false;
-  api.ui.status = '';
-  if (api.ui.progress) api.ui.progress.start('npm');
-  const runner = api.ui.repo && api.ui.repo.runNpmCommand;
-  const start = typeof runner === 'function' ? runner : startNpm;
-  api.state.child = start(
-    api.ui.top,
-    entry,
-    (text) => showOutput(api, reduceOutput(text, api.ui.top, '')),
-    (result) => finishRun(api, entry, result),
-  );
-  api.ui.paint();
-};
+class NpmController {
+  constructor(ui) {
+    this.ui = ui;
+    this.child = null;
+    this.running = false;
+    this.reset();
+  }
 
-const runSelected = (api) => {
-  if (api.state.viewing || api.state.child) return;
-  const entry = selected(api);
-  if (!entry) return;
-  startRun(api, entry);
-};
+  reset() {
+    if (this.child) this.child.kill();
+    this.stopRun();
+    this.commands = [];
+    this.viewing = false;
+    this.output = '';
+    this.followEnd = true;
+    this.logScroll = 0;
+    this.editName = '';
+    this.editField = '';
+    this.draftName = '';
+    this.draftCommand = '';
+    this.verbose = false;
+    this.raw = '';
+    this.exitStatus = '';
+    this.dropName = '';
+    this.dropKind = '';
+    this.logBytes = 0;
+    this.stopping = false;
+    this.runLabel = '';
+    this.startedAt = 0;
+    this.endedAt = 0;
+  }
 
-const rerun = (api) => {
-  if (!api.state.viewing || api.state.running) return;
-  const entry = selected(api);
-  if (!entry) return;
-  startRun(api, entry);
-};
+  get logLabel() {
+    if (!this.logBytes) return '';
+    return `old logs ${bytesToSize(this.logBytes)}`;
+  }
 
-const closeView = (api) => {
-  if (api.state.running) {
-    api.state.stopping = true;
-    if (api.state.child) api.state.child.kill();
-    if (!api.state.running) return;
-    api.state.output = withNotice(api.state.output, 'terminated');
-    stopRun(api);
-    api.ui.status = 'terminated';
-    api.ui.paint();
-    return;
-  }
-  api.state.viewing = false;
-  api.ui.status = '';
-  api.ui.paint();
-};
+  get lastRun() {
+    if (!this.startedAt) return null;
+    return {
+      label: this.runLabel,
+      running: this.running,
+      exit: this.exitStatus,
+      startedAt: this.startedAt,
+      endedAt: this.endedAt,
+    };
+  }
 
-const editSelected = (api) => {
-  if (api.state.viewing) return;
-  if (!canEdit(api.ui)) {
-    api.ui.status = 'read only';
-    return;
+  selected() {
+    return this.commands[this.ui.nav.npmCursor];
   }
-  const entry = selected(api);
-  if (!entry || entry.kind !== 'script') {
-    api.ui.status = 'not a script';
-    return;
+
+  refresh() {
+    this.commands = listCommands(this.ui.top);
+    const last = this.commands.length - 1;
+    const nav = this.ui.nav;
+    nav.npmCursor = Math.max(0, Math.min(nav.npmCursor, last));
   }
-  api.state.editName = entry.name;
-  api.ui.composer.openCompose('npm', scriptLine(entry));
-};
 
-const newCommand = (api) => {
-  if (api.state.viewing) return;
-  if (!canEdit(api.ui)) {
-    api.ui.status = 'read only';
-    return;
+  refreshLogs() {
+    try {
+      this.logBytes = staleLogFiles(this.ui.top).bytes;
+    } catch (error) {
+      this.logBytes = 0;
+      this.ui.status = error.message;
+    }
   }
-  api.state.editName = '';
-  api.ui.composer.openCompose('npm', '');
-};
 
-const finishEdit = (api) => {
-  const editor = api.ui.composer.state.editor;
-  const text = editor ? editor.text : '';
-  const parsed = parseScriptLine(text);
-  if (!parsed) {
-    api.ui.status = 'name: command';
-    return;
-  }
-  try {
-    api.ui.ignoreWatch();
-    saveScript(api.ui.top, api.state.editName, parsed);
-  } catch (error) {
-    api.ui.status = error.message;
-    return;
-  }
-  api.ui.composer.closeCompose();
-  refresh(api);
-  const at = api.state.commands.findIndex(
-    (entry) => entry.name === parsed.name,
-  );
-  if (at >= 0) api.ui.nav.npmCursor = at;
-  api.ui.status = 'saved';
-};
+  open() {
+    if (this.ui.mode === 'compose') return;
+    this.refresh();
+    this.refreshLogs();
+    this.viewing = false;
+    this.output = '';
+    const nav = this.ui.nav;
+    nav.pane = 'npm';
+    nav.resetListScroll('npm');
+    this.ui.status = '';
+    nav.clearSelection();
+  }
 
-const askDrop = (api) => {
-  if (api.state.viewing) return;
-  if (!canEdit(api.ui)) {
-    api.ui.status = 'read only';
-    return;
-  }
-  const entry = selected(api);
-  if (!entry || entry.kind !== 'script') {
-    api.ui.status = 'not a script';
-    return;
-  }
-  api.state.dropKind = 'script';
-  api.state.dropName = entry.name;
-  api.ui.mode = 'confirmDrop';
-  api.ui.status = '';
-};
+  scrollLog(delta) {
+    const { lastFrame, lastSize } = this.ui;
+    const width = lastSize && lastSize.width ? lastSize.width : 0;
+    const count = logRowCount(this.output, width, this.running);
+    const bodyH = lastFrame && lastFrame.bodyH ? lastFrame.bodyH : 1;
+    const max = Math.max(0, count - logViewRows(bodyH));
+    const from = this.followEnd ? max : this.logScroll;
+    const start = Math.min(max, Math.max(0, from + delta));
+    this.followEnd = start === max;
+    this.logScroll = start;
+  }
 
-const askLogs = (api) => {
-  if (api.state.viewing) return;
-  if (!canEdit(api.ui)) {
-    api.ui.status = 'read only';
-    return;
-  }
-  refreshLogs(api);
-  if (!api.state.logBytes) return;
-  api.state.dropKind = 'logs';
-  const size = formatSize(api.state.logBytes);
-  api.state.dropName = `logs older than 5 days (${size})`;
-  api.ui.mode = 'confirmDrop';
-  api.ui.status = '';
-};
+  move(delta) {
+    if (this.viewing) return void this.scrollLog(delta);
+    if (!this.commands.length) return;
+    const nav = this.ui.nav;
+    const last = this.commands.length - 1;
+    const next = Math.min(last, Math.max(0, nav.npmCursor + delta));
+    if (next === nav.npmCursor) return;
+    nav.npmCursor = next;
+    this.ui.status = '';
+  }
+
+  stopRun() {
+    if (this.running) this.endedAt = Date.now();
+    this.running = false;
+    this.child = null;
+    this.ui.progress.stop('npm');
+  }
+
+  shownOutput(raw, status) {
+    if (this.verbose) return withNewline(raw);
+    return filteredOutput(raw, this.ui.top, status).output;
+  }
+
+  showOutput(text) {
+    if (!this.viewing || !this.running || this.stopping) return;
+    this.raw = text;
+    this.output = this.shownOutput(text, '');
+    this.ui.paint();
+  }
+
+  async finishRun(entry, result) {
+    const ui = this.ui;
+    const stopped = this.stopping === true;
+    const raw = stopped ? withNotice(this.raw, 'terminated') : result.text;
+    let slot = null;
+    try {
+      slot = nextLogFile(ui.top, entry.name);
+    } catch (error) {
+      ui.status = error.message;
+    }
+    const rawFile = slot ? slot.rawName : '';
+    const stoppedOutput = () => {
+      const output = withNotice(
+        reduceOutput(this.raw, ui.top, ''),
+        'terminated',
+      );
+      return { output, log: output };
+    };
+    const filtered = stopped
+      ? stoppedOutput()
+      : filteredOutput(result.text, ui.top, result.status, rawFile);
+    this.raw = raw;
+    this.exitStatus = stopped ? '' : result.status;
+    this.output = this.verbose ? this.shownOutput(raw, '') : filtered.output;
+    this.stopping = false;
+    this.stopRun();
+    if (stopped && this.viewing) ui.status = 'terminated';
+    ui.paint();
+    if (!slot) return;
+    try {
+      await saveLogs(slot, loggedText(filtered.log, slot.rawName), raw);
+    } catch (error) {
+      ui.status = error.message;
+      ui.paint();
+    }
+  }
 
-const confirmDrop = (api) => {
-  const kind = api.state.dropKind;
-  const name = api.state.dropName;
-  api.state.dropName = '';
-  api.state.dropKind = '';
-  api.ui.mode = 'review';
-  if (kind === 'logs') {
+  startRun(entry) {
+    const ui = this.ui;
+    this.output = '';
+    this.raw = '';
+    this.exitStatus = '';
+    this.viewing = true;
+    this.followEnd = true;
+    this.logScroll = 0;
+    this.running = true;
+    this.stopping = false;
+    this.runLabel = runLabel(entry);
+    this.startedAt = Date.now();
+    this.endedAt = 0;
+    ui.status = '';
+    ui.progress.start('npm');
+    const start = (ui.repo && ui.repo.runNpmCommand) || startNpm;
+    const child = start(
+      ui.top,
+      entry,
+      (text) => this.showOutput(text),
+      (result) => this.finishRun(entry, result),
+    );
+    if (this.running) this.child = child;
+    ui.paint();
+    return child;
+  }
+
+  run() {
+    if (this.viewing || this.child) return null;
+    const entry = this.selected();
+    if (!entry) return null;
+    this.verbose = false;
+    return this.startRun(entry);
+  }
+
+  rerun() {
+    if (!this.viewing || this.running) return;
+    const entry = this.selected();
+    if (entry) this.startRun(entry);
+  }
+
+  closeView() {
+    const ui = this.ui;
+    if (!this.running) {
+      this.viewing = false;
+      this.verbose = false;
+      ui.status = '';
+      return void ui.paint();
+    }
+    this.stopping = true;
+    if (this.child) this.child.kill();
+    if (!this.running) return;
+    this.raw = withNotice(this.raw, 'terminated');
+    this.output = this.verbose
+      ? this.shownOutput(this.raw, '')
+      : withNotice(this.output, 'terminated');
+    this.stopRun();
+    ui.status = 'terminated';
+    ui.paint();
+  }
+
+  toggleVerbose() {
+    if (!this.viewing) return;
+    this.verbose = !this.verbose;
+    const status = this.running ? '' : this.exitStatus;
+    this.output = this.shownOutput(this.raw, status);
+    this.ui.status = this.verbose ? 'verbose' : 'filtered';
+    this.ui.paint();
+  }
+
+  editable() {
+    if (this.viewing) return false;
+    const ui = this.ui;
+    const caps = ui.capabilities;
+    if (!ui.readOnly && (!caps || caps.changes !== false)) return true;
+    ui.status = 'read only';
+    return false;
+  }
+
+  selectedScript() {
+    if (!this.editable()) return null;
+    const entry = this.selected();
+    if (entry && entry.kind === 'script') return entry;
+    this.ui.status = 'not a script';
+    return null;
+  }
+
+  focusScript(name) {
+    const at = this.commands.findIndex((entry) => entry.name === name);
+    if (at >= 0) this.ui.nav.npmCursor = at;
+  }
+
+  startEdit(name, command) {
+    this.editName = name;
+    this.editField = 'name';
+    this.draftName = name;
+    this.draftCommand = command;
+    this.ui.composer.openCompose('npm', name);
+  }
+
+  edit() {
+    const entry = this.selectedScript();
+    if (entry) this.startEdit(entry.name, entry.command ?? '');
+  }
+
+  create() {
+    if (this.editable()) this.startEdit('', '');
+  }
+
+  switchField(editor, field, text) {
+    this.editField = field;
+    editor.replace(text);
+    this.ui.status = '';
+  }
+
+  finishName(editor) {
+    const name = editor.text.trim();
+    if (!name || !NAME_RE.test(name)) {
+      this.ui.status = 'name';
+      return false;
+    }
+    this.draftName = name;
+    this.switchField(editor, 'command', this.draftCommand);
+    return true;
+  }
+
+  focusField(field) {
+    const editor = this.ui.editor;
+    if (!editor) return false;
+    if (field === this.editField) return true;
+    if (field === 'command') return this.finishName(editor);
+    this.draftCommand = editor.text;
+    this.switchField(editor, 'name', this.draftName);
+    return true;
+  }
+
+  writeScripts(write) {
     try {
-      removeStaleLogs(api.ui.top);
+      this.ui.ignoreWatch();
+      write(this.ui.top);
+      return true;
     } catch (error) {
-      api.ui.status = error.message;
-      refreshLogs(api);
+      this.ui.status = error.message;
+      return false;
+    }
+  }
+
+  finishEdit() {
+    const ui = this.ui;
+    const editor = ui.composer.editor;
+    if (!editor) return;
+    if (this.editField !== 'command') return void this.finishName(editor);
+    const command = editor.text.trim();
+    if (!command) {
+      ui.status = 'command';
       return;
     }
-    refreshLogs(api);
-    api.ui.status = 'dropped logs';
-    return;
-  }
-  if (!name) return;
-  try {
-    api.ui.ignoreWatch();
-    removeScript(api.ui.top, name);
-  } catch (error) {
-    api.ui.status = error.message;
-    return;
-  }
-  refresh(api);
-  api.ui.status = `dropped ${name}`;
-};
+    const parsed = { name: this.draftName, command };
+    const write = (top) => saveScript(top, this.editName, parsed);
+    if (!this.writeScripts(write)) return;
+    this.editField = '';
+    ui.composer.closeCompose();
+    this.refresh();
+    this.focusScript(parsed.name);
+    ui.status = 'saved';
+  }
 
-const cancelDrop = (api) => {
-  api.state.dropName = '';
-  api.state.dropKind = '';
-  api.ui.mode = 'review';
-  api.ui.status = '';
-};
+  confirm(kind, name) {
+    this.dropKind = kind;
+    this.dropName = name;
+    this.ui.mode = 'confirmDrop';
+    this.ui.status = '';
+  }
 
-const reorder = (api, delta) => {
-  if (api.state.viewing) return;
-  if (!canEdit(api.ui)) {
-    api.ui.status = 'read only';
-    return;
-  }
-  const entry = selected(api);
-  if (!entry || entry.kind !== 'script') {
-    api.ui.status = 'not a script';
-    return;
-  }
-  try {
-    api.ui.ignoreWatch();
-    if (!reorderScript(api.ui.top, entry.name, delta)) return;
-  } catch (error) {
-    api.ui.status = error.message;
-    return;
-  }
-  refresh(api);
-  const at = api.state.commands.findIndex((item) => item.name === entry.name);
-  if (at >= 0) api.ui.nav.npmCursor = at;
-  api.ui.status = '';
-};
+  askDrop() {
+    const entry = this.selectedScript();
+    if (entry) this.confirm('script', entry.name);
+  }
 
-const createNpmController = (ui) => {
-  const state = {
-    commands: [],
-    viewing: false,
-    output: '',
-    followEnd: true,
-    logScroll: 0,
-    editName: '',
-    dropName: '',
-    dropKind: '',
-    logBytes: 0,
-    running: false,
-    stopping: false,
-    child: null,
-  };
-  const api = { ui, state };
-  return {
-    state,
-    get commands() {
-      return state.commands;
-    },
-    get viewing() {
-      return state.viewing;
-    },
-    get output() {
-      return state.output;
-    },
-    get dropName() {
-      return state.dropName;
-    },
-    get logLabel() {
-      if (!state.logBytes) return '';
-      return `old logs ${formatSize(state.logBytes)}`;
-    },
-    get followEnd() {
-      return state.followEnd;
-    },
-    get logScroll() {
-      return state.logScroll;
-    },
-    get editName() {
-      return state.editName;
-    },
-    get running() {
-      return state.running;
-    },
-    reset() {
-      if (state.child) state.child.kill();
-      stopRun(api);
-      state.commands = [];
-      state.viewing = false;
-      state.output = '';
-      state.followEnd = true;
-      state.logScroll = 0;
-      state.editName = '';
-      state.dropName = '';
-      state.dropKind = '';
-      state.logBytes = 0;
-      state.stopping = false;
-    },
-    open: () => open(api),
-    move: (delta) => move(api, delta),
-    run: () => runSelected(api),
-    rerun: () => rerun(api),
-    closeView: () => closeView(api),
-    edit: () => editSelected(api),
-    create: () => newCommand(api),
-    finishEdit: () => finishEdit(api),
-    askDrop: () => askDrop(api),
-    askLogs: () => askLogs(api),
-    confirmDrop: () => confirmDrop(api),
-    cancelDrop: () => cancelDrop(api),
-    reorder: (delta) => reorder(api, delta),
-  };
-};
+  askLogs() {
+    if (!this.editable()) return;
+    this.refreshLogs();
+    if (!this.logBytes) return;
+    const size = bytesToSize(this.logBytes);
+    this.confirm('logs', `logs older than 5 days (${size})`);
+  }
+
+  cancelDrop() {
+    this.dropName = '';
+    this.dropKind = '';
+    this.ui.mode = 'review';
+    this.ui.status = '';
+  }
+
+  confirmDrop() {
+    const ui = this.ui;
+    const kind = this.dropKind;
+    const name = this.dropName;
+    this.dropName = '';
+    this.dropKind = '';
+    ui.mode = 'review';
+    if (kind === 'logs') {
+      try {
+        removeStaleLogs(ui.top);
+      } catch (error) {
+        ui.status = error.message;
+        return void this.refreshLogs();
+      }
+      this.refreshLogs();
+      ui.status = 'dropped logs';
+      return;
+    }
+    if (!name) return;
+    if (!this.writeScripts((top) => removeScript(top, name))) return;
+    this.refresh();
+    ui.status = `dropped ${name}`;
+  }
+
+  reorder(delta) {
+    const entry = this.selectedScript();
+    if (!entry) return;
+    let moved = false;
+    const write = (top) => {
+      moved = reorderScript(top, entry.name, delta);
+    };
+    if (!this.writeScripts(write) || !moved) return;
+    this.refresh();
+    this.focusScript(entry.name);
+    this.ui.status = '';
+  }
+}
 
-module.exports = { createNpmController };
+module.exports = { NpmController };